EventGetRankingRuleDefinitionAsync Method

Note: This API is now obsolete.

Retreives the RankingRule Definition referenced by the instantiating class.

Definition

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

C#

[ObsoleteAttribute("Use GetRankingRuleDefinitionListAsync() instead.")]
public Task<RankingRule> GetRankingRuleDefinitionAsync()

Return Value

TaskRankingRule

Implements

IGetRankingRuleDefinitionGetRankingRuleDefinitionAsync

Remarks

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

Exceptions

ArgumentNullException	Thrown if the value for RankingRuleDef is empty
DefinitionNotFoundException
ScoposAPIException