home

CreditsEarnedInfo

Name CreditsEarnedInfo
Usage GradingService
updateCredit
GradeRosterEntryInfo
Type Complex

Description

Information about an assigned grade in a roster entry

Structure Definition

ShortName Name Type Description Required? Read only? 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
Required on updates Read only One Yes  
creditGroupId Credit Group Id String Credit group to which the credit belongs     One No maps to LearningResultRecord.resultValueGroupId in LRR
credit Credit String Credit Earned     One No maps to ResultValue.value in LRC where resultValue.Id = LearningResultRecord.resultValueId in LRR. The resultSourceId in the LRR should be sourceId for source used for credit calculation. In case the credits are manually entered, the source should be of manually set credits
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.
Required on updates Read only 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