SocRolloverResultInfo

Name SocRolloverResultInfo
Usage CourseOfferingSetService
reverseRollover getSocRolloverResult getSocRolloverResultsByIds getSocRolloverResultsBySourceAndTargetSocs createSocRolloverResult updateSocRolloverResult updateSocRolloverProgress validateSocRolloverResult searchForSocRolloverResults
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  
sourceSocId Source Soc Id String The id of the source soc Required Read only One No set during the #rolloverSoc operation
targetSocId Target Soc Id String The id of the target Soc

Note: this Soc could have already existed or it may have been created
based on the source soc but for the new term.		 Required Read only One No set during the #rolloverSoc operation
targetTermId Target Term Id String Academic target term of the courses that were rolled over Required Read only One No set during the #rolloverSoc operation
optionKeys Option Keys StringList Option Keys specified to control the rollover process Required Read only Many No set during the #rolloverSoc operation
itemsProcessed Items Processed Integer Number of items processed     One No set during the #rolloverSoc operation
itemsExpected Items Expected Integer Number of items expected to be processed     One No set during the #rolloverSoc operation
courseOfferingsCreated Course Offerings Created Integer Number of course offerings created   Read only One No set during the #rolloverSoc operation
courseOfferingsSkipped Course Offerings Skipped Integer Number of course offerings skipped (not rolled over)   Read only One No set during the #rolloverSoc operation
activityOfferingsCreated Activity Offerings Created Integer Number of activity offerings created   Read only One No set during the #rolloverSoc operation
activityOfferingsSkipped Activity Offerings Skipped Integer Number of activity offerings skipped (not rolled over)   Read only One No set during the #rolloverSoc operation
sourceTermId Source Term Id String Get the target term Id   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.		     One No set during the #rolloverSoc operation
dateInitiated Date Initiated Date Get date that the rollover started on. Date includes hours/minutes/seconds.     One No  
dateCompleted Date Completed Date Get the date that the rollover completed. Date includes hours/minutes/seconds.     One No  
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