For Babelfish Release 1.11.1.3

ResultList Class

Definition

Namespace: Scopos.BabelFish.DataModel.OrionMatch
Assembly: BabelFish (in BabelFish.dll) Version: 1.11.1.4+b1da393815f6638555a663d9a94167ecabea5695
C#
[SerializableAttribute]
public class ResultList : ITokenItems<ResultEvent>, 
	IRLIFList, IGetResultListFormatDefinition, IGetCourseOfFireDefinition, IGetRankingRuleDefinition, IPublishTransactions
Inheritance
Object    ResultList
Implements
IGetCourseOfFireDefinition, IGetRankingRuleDefinition, IGetResultListFormatDefinition, IPublishTransactions, ITokenItemsResultEvent, IRLIFList

Constructors

Properties

CourseOfFireDef The SetName of the Course of Fire
Creator String holding the software (Orion Scoring System) and Version number of the software.
Obsolete
EndDate The end date that the underlying event, in this Result List, ended on. In a Virtual Match, this value is the composite value of each parent and child match.
EventName EventName is the name of the top level Event for this Result List.
HasMoreItems Indicates if this get/read response has more items. Almost always determiend if NextToken is null or an empty string.
Items 
JSONVersion The Version string of the JSON document
LastUpdated UTC time that this Result List was updated.
Limit The maximum number of items that may be returned in a get/read response. The user may request a limit, usually between 1 and 50, but the API is allowed to restrict the value of limit. This is the value the API used.
MatchID If this is a local match, returns the local match id. If this is from a virtual match, retur s the virtual match id.
MatchName 
Metadata Key is the local match ID. Value is the Metadate for the generative match. When Orion generates a ResultList there will only be 1 value in Metadata. When a Virtual Match is merged, each parent / child ID will be listed. Local Matches will have exactly one value.
Name 
NextToken When there are more items to return, NextToken contains the next token to pass to the call to the next set of items. A value of null or empoty string indicate there are no more items to return.
OwnerId The orion account or at home account who owns this match.
Obsolete
ParentID 
Partial Indicates if the Result List has been truncated. and the values in .Items are not all of the results. Currently known to be set in the Reat API Get Result List lambda, when pulling result lists from dynamo that are too large. There is some remaining question if this field is needed. In theory .Partial is the opposite of .HasMoreItems
Primary Set to true if this ResultList is considered one of the most important and should be featured
Projected If True, Participants are listed in order of their projected score. Should only ever be true if Status is FUTURE or INTERMEDIATE
PublishTransactionId When a message with a list is too large, the list may be published through a series of transactions. Each sub-message must have the same PublishTransactionId. It is the responsiblity of the publisher to ensure this and to break the original message up. The Receiver is responsible for re-assembling the messages. An empty string value is assumed to mean that the original message was small enought in size that it didn't need to be broken up.
RankingRuleDef Set name of the Ranking Rule definition used to rank this result list.
ResultListFormatDef Set name of the Result List Format definition to use when displaying this result list.
ResultListID 
ResultName 
ScoreConfigName The ScoreConfigName to use, within the SCORE FORMAT COLLECTION definition to format scores.

NOTE: The SCORE FORMAT COLLECTION is specified within the RESULT LIST FORMAT definition.

StartDate The start date that the underlying event, in this Result List, started on. In a Virtual Match, this value is the composite value of each parent and child match.
Status Indicates the completion status of this Result List. If this is a Virtual Match, the overall Result List status is based on the composite statuses of each parent and child result list.
Team 
TransactionCount When a list has to be published over multiple messages, this is the index value of the last message that will be sent. When TransactionSequence == TransactionCount - 1 (assuming in order receipt) this will be the last message for this transaction.
TransactionSequence When a list has to be published over multiple messages, this is the 0 based index of the broken up messages.
UniqueID 

Methods

EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
GetAsIRLItemsList Method to return the list of IRLIFItem items.

Both SquaddingList and ResultList have a List of Squadding or List of ResultEvent already. However there is no straightforward way to case these lists as List of IRLIFItem. This method bridges that gap.

GetCourseOfFireDefinitionAsync Retreives the COURSE OF FIRE Definition referenced by the instantiating class.
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetRankingRuleDefinitionAsync Retreives the RankingRule Definition referenced by the instantiating class.
GetResultListFormatDefinitionAsync Retreives the ResultListFormat Definition referenced by the instantiating class.
GetTypeGets the Type of the current instance.
(Inherited from Object)
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
ToStringReturns a string that represents the current object.
(Overrides ObjectToString)
TryGetByResultCOFID 

Extension Methods

CalculateResultListStatus Determines, but does not set, the Status of the ResultList. Rules for it are: * If the match's status is OFFICIAL, so is the ResultList. * If not participants are in the ResultList then the status if FUTURE * If all participant's event status is FUTURE, so is the ResultList * If one or more participant's event status is INTERMEDIATE, so is the ResultList * If one or more participant's event status is UNOFFICIAL, and no one's is INTERMEDIATE, then result status is UNOFFICIAL * Default case is, result status is equal to the match's status
(Defined by ResultListExtensions)
ListOfRelays Returns a unique list of relays that one more more participants are squadded on.

Relay "0" is excluded.


(Defined by IRLIFListExtensions)
ReSortIfOfficial Checks for the unusual condition that the returned result list is ordered by projected rank, but the status is UNOFFICIAL or OFFICIAL. This could happen if a user turns Orion off, before having all scores turned in, and we're past the end date of the match.
(Defined by ResultListExtensions)

See Also