home

RegRequestItemInfo

Name RegRequestItemInfo
Usage CourseRegistrationService
RegRequestInfo
Type Complex

Description

Represents a single reg group in the request to register. This request is
also used to request waitlist or drop a course. It has transaction type of
either ADD, DROP, SWAP or UPDATE to represent adding (waitlisting,
holdlisting), dropping courses or persisting an item from the reg cart with
changes to it. It has other options like grading and credit options that a
student can specify while registering. There will be options like
okToWaitlist, okToHoldList, okToExceptionList which will help specify if the
student wants to go to a waitlist/holdlist in case there's no seat
availability for the course. A request to waitlist a course should always
have okToWaitlist set to true, same for hold or exception lists.


************POSSIBLE SCENARIOS******************************* 1. Register for
course - {@link RegRequestItem} Type is ADD , newRegGroupId is the reg group
to be registered for 2. Register for course but waitlist if seat not
available OR waitlist for course - same as above and okToWaitlist is true 3.
Swap between reg group within same course offering - Type is swap, both new
and existing reg group Ids populated. new is to be the one replaced with the
old one. Reg groups are in the same course offering. 4.Save reg request -
Type is UPDATE and newRegGroupId is populated

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  
name Name String A display name for this entity.     One No  
descr Description RichTextInfo A description of the entity.     One No  
typeKey Type Key String The possible types of RegRequestItem are ADD, DROP, SWAP or UPDATE. Those
types represent adding (waitlisting, holdlisting), dropping courses or
persisting an item from the reg cart with changes to it.		 Required Read only One Yes  
stateKey State Key String Represents the state of this request - NEW, DRAFT, SUBMITTED, FAILED etc Required   One Yes  
studentId Student Id String Return the id of the student to be registered     One No  
newRegGroupId New Reg Group Id String Returns the id of the RegGroup for this item. This is populated for ADD,
DROP, UPDATE and SWAP types of RegRequestItem		     One No  
existingRegGroupId Existing Reg Group Id String Returns the existing reg group id. The existing reg group field is
populated if we have DROP or SWAP types of Request item.		     One No  
okToWaitlist Ok To Waitlist Boolean If the course is full and there is a waitlist, is it okay to be placed in
the waitlist for the course		     One No  
okToHoldList Ok To Hold List Boolean If the student does not meet one of the requirements for the course but
there is a list for such students because the requirement ends at a
future date, is it okay to be placed in such a list.		     One No  
gradingOptionKey Grading Option Key String Specify the preferred grading option for the course e.g. pass/fail since
the course allows to specify such options		     One No  
creditOptionKey Credit Option Key String Specify the preferred credit option e.g credit/ no-credit for the course
because the course.		     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