SocRolloverResultItemInfo

Name SocRolloverResultItemInfo
Usage CourseOfferingSetService
getSocRolloverResultItemsByIds getSocRolloverResultItemsByResultId getSocRolloverResultItemsByResultIdAndSourceCourseOfferingId getSocRolloverResultItemsByResultIdAndTargetCourseOfferingId getSocRolloverResultItem createSocRolloverResultItem createSocRolloverResultItems updateSocRolloverResultItem validateSocRolloverResultItem
Type Complex

Description

Read only object that holds the results of a rollover process

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  
typeKey Type Key String A unique identifier for the type of this object. Required Read only One Yes  
stateKey State Key String A unique identifier for the state of this object. Required   One Yes  
socRolloverResultId Soc Rollover Result Id String The id of the rollover result to which this item belongs Required Read only One No set during the #rolloverSoc operation
sourceCourseOfferingId Source Course Offering Id String The id of the source course offering Required Read only One No set during the #rolloverSoc operation
targetCourseOfferingId Source Course Offering Id String The id of the target course offering

Can be null if the rollover did not rollover the source course offering.		   Read only One No set during the #rolloverSoc operation
message Message RichTextInfo Messages describing details of the status.

Often left null if the status is that it is complete.		   Read only One No set during the #rolloverSoc operation
meta Meta 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