EventGetResultListFormatDefinitionAsync Method

Retreives the ResultListFormat Definition referenced by the instantiating class.

Definition

Namespace: Scopos.BabelFish.DataModel.Definitions
Assembly: BabelFish (in BabelFish.dll) Version: 1.11.1.4+b1da393815f6638555a663d9a94167ecabea5695

C#

public Task<ResultListFormat> GetResultListFormatDefinitionAsync()

Return Value

TaskResultListFormat

Implements

IGetResultListFormatDefinitionGetResultListFormatDefinitionAsync

Remarks

It is a best practice to check for null or empty string for the value of .ResultListFormatDef. This is because .ResultListFormatDef is not a required property and is allowed to be empty. If it is empty, calling this function GetResultListFormatDefinitionAsync() will throw an exception.

Exceptions

ArgumentNullException	Thrown if the value for ResultListFormatDef is empty.
DefinitionNotFoundException
ScoposAPIException