home

CollectionEntryInfo

Name CollectionEntryInfo
Usage EntitiesCollectionService
getHighestRankedEntry createEntry
Type Complex

Description

This is a description of what this class does - sambitpatnaik don't forget to fill this in.

Structure Definition

ShortName Name Type Description Cardinality XML Attribute? Implementation Notes
id Unique Id String The system assigned unique id to identify this Object.
Could be implemented as as sequence number or as a UUID.

Attempts to set this value on creates should result in a ReadOnlyException being thrown

An Id:

  • An id is used when the actual value is unimportant and can therefore be a large hex value for example
  • An id value might be 23b9ca9bd203df902
  • An Id is never intended to be used directly by an end user.
  • Ids are assumed to be of different values in different KS implementations
  • Id values are generated by the service implementations
  • Id values are never expected to be used in Configuration or Application code
 One Yes  
typeKey Type Key String Unique identifier for the type of this object. One Yes  
stateKey State Key String Unique identifier for the state of this object. One Yes  
name Name String A display name for this entity. One No  
descr Description RichTextInfo A description of the entity. One No  
entryRefObjectId Entry Ref Object Id String ??? One No  
entryRefObjectTypeKey Entry Ref Object Type Key String ??? One No  
checkInDate Check In Date Date ??? One No  
position Position Integer ??? One No  
meta Create/Update meta info MetaInfo Create and last update info for the structure. This is optional
and treated as read only since the data is set by the internals
of the service during maintenance operations.

Contains audit trail information about the creation and last
update of this object Also contains the version ind used for
optimistic locking.

Attempts to set or update should result in a ReadOnlyException
being thrown.		 One No  
attributes Dynamic Attributes AttributeInfoList List of dynamic attributes, each holding a key-value pair that
can be configured to hold additional information for an
implementing institution.

Note: the key may be repeated more than once to simulate a list
of values.		 Many No