RegistrationGroupInfo

Name RegistrationGroupInfo
Usage CourseOfferingService CourseRegistrationService
generateRegistrationGroupsForFormatOffering getRegistrationGroup getRegistrationGroupsByIds getRegistrationGroupsForCourseOffering getRegistrationGroupsWithActivityOfferings getRegistrationGroupsByFormatOffering validateRegistrationGroup createRegistrationGroup updateRegistrationGroup generateRegistrationGroupsForCluster searchForRegistrationGroups getEligibleRegistrationGroupsForStudentInCourseOffering
Type Complex

Description

Registration group are the physical entities that students will try
to register into. A RegistrationGroup is used to group individual
activity offerings based on the canonical format.

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  
name Name String A display name for this entity.     One No  
descr Description RichTextInfo A description of the entity.     One No  
formatOfferingId Format Id String Canonical format to which this registration group belong to. Required Read only One No This maps the the version dependent id of the format
clu. Stored as cluId in Lui.
courseOfferingId CourseOffering Id String Course offering for this registration group. Required Read only One No Maps to the lui Id of the courseOffering retrieved from
luiluirelation of type courseoffering to registration
group.
termId Term id String Academic term the registration group is being offered
in. Should be same as CourseOffering unless changed, then must
be nested term of courseOffering.		 Required Read only One No maps to Lui.getAtpId()
registrationCode Registration Code String Uniquely identifies an instance of the course for the purposes
of registration. This code is unique for a given term, thus, no
two registration groups in the same term shares the same registration
code.

By contrast, the [name] field (this is inherited from IdEntity) is used to store
a registration group code that is unique only within a course offering.
Thus, no two registration groups would share the same registration group
code within the same course offering (in a given term).		     One No maps to lui code in Lui
activityOfferingIds ActivityOffering Ids StringList Activity Offerings for the registration group. This list should
be constrained by the canonical format and the activity
offerings listed in the course offering.		     Many No Maps to the lui Ids of the activityOffering retrieved
from luiluirelation of type activityOffering to
registration group.
isGenerated Is Generated Boolean Tests if this registration group wa sthe product of an
automatic generation. manually created registration groups
return false for this.		     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