| Name | regRequestItemInfo |
|---|---|
| Label | Reg Request Item |
| JSTL Key | RegRequestItemInfo |
| Java Class | org.kuali.student.enrollment.courseregistration.dto.RegRequestItemInfo |
| 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 |
| Primary Key(s) | name |
| Field to use as the title (or name) | name |
| Field | Required? | DataType | Length | Short Label | Summary | Label | Description | Read Only, Dynamic, or Hidden | Default | Repeats? | Valid Characters | Lookup | Cross Field | Default Control |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| name | STRING | 1 to 255 | Name | A display name for this entity. | Name | A display name for this entity. |
validation.noWhitespace ^[\x21-\x7E\t\r\n\v\f\s]*$ |
TextControl | ||||||
| typeKey | required | STRING | 1 to 80 | Type Key | The possible types of RegRequestItem are ADD, DROP, SWAP or UPDATE. | Type Key | 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. |
validation.alphanumericPattern ^[A-Za-z0-9.\-]*$ |
TextControl | |||||
| stateKey | required | STRING | 1 to 80 | State Key | Represents the state of this request - NEW, DRAFT, SUBMITTED, FAILED etc | State Key | Represents the state of this request - NEW, DRAFT, SUBMITTED, FAILED etc |
validation.alphanumericPattern ^[A-Za-z0-9.\-]*$ |
TextControl | |||||
| studentId | STRING | 1 to 255 | Student Id | Return the id of the student to be registered | Student Id | Return the id of the student to be registered |
validation.noWhitespace ^[\x21-\x7E\t\r\n\v\f\s]*$ |
TextControl | ||||||
| newRegGroupId | STRING | 1 to 255 | New Reg Group Id | Returns the id of the RegGroup for this item. | New Reg Group Id | Returns the id of the RegGroup for this item. This is populated for ADD, DROP, UPDATE and SWAP types of RegRequestItem |
validation.noWhitespace ^[\x21-\x7E\t\r\n\v\f\s]*$ |
TextControl | ||||||
| existingRegGroupId | STRING | 1 to 255 | Existing Reg Group Id | Returns the existing reg group id. | Existing Reg Group Id | Returns the existing reg group id. The existing reg group field is populated if we have DROP or SWAP types of Request item. |
validation.noWhitespace ^[\x21-\x7E\t\r\n\v\f\s]*$ |
TextControl | ||||||
| okToWaitlist | BOOLEAN | Ok To Waitlist | If the course is full and there is a waitlist, is it okay to be placed in the waitlist for the course | Ok To Waitlist | If the course is full and there is a waitlist, is it okay to be placed in the waitlist for the course | CheckboxControl | ||||||||
| okToHoldList | BOOLEAN | Ok To Hold List | 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. | Ok To Hold List | 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. | CheckboxControl | ||||||||
| gradingOptionKey | STRING | 1 to 255 | Grading Option Key | Specify the preferred grading option for the course e.g. pass/fail since the course allows to specify such options | Grading Option Key | Specify the preferred grading option for the course e.g. pass/fail since the course allows to specify such options |
validation.noWhitespace ^[\x21-\x7E\t\r\n\v\f\s]*$ |
TextControl | ||||||
| creditOptionKey | STRING | 1 to 255 | Credit Option Key | Specify the preferred credit option e.g credit/ no-credit for the course because the course. | Credit Option Key | Specify the preferred credit option e.g credit/ no-credit for the course because the course. |
validation.noWhitespace ^[\x21-\x7E\t\r\n\v\f\s]*$ |
TextControl | ||||||
| descr.plain | STRING | 1 to 14000 | Plain Text | The plain text version of the descrpition | Plain Text Description | The plain text version of the descrpition |
validation.noWhitespace ^[\x21-\x7E\t\r\n\v\f\s]*$ |
TextAreaControl | ||||||
| descr.formatted | STRING | 1 to 14000 | Fromatted Text | The formatted text version of the descrpition | Fromatted Text Description | The formatted text version of the descrpition |
validation.noWhitespace ^[\x21-\x7E\t\r\n\v\f\s]*$ |
TextAreaControl | ||||||
| meta.versionInd | STRING | 1 to 80 | Version Ind | Optimistic Locking Flag | Version Ind | Field used to check optimistic locking, updated on each update |
validation.noWhitespace ^[\x21-\x7E\t\r\n\v\f\s]*$ |
TextControl | ||||||
| meta.createTime | DATE | must be 19 | Created on | The date/time stamp of when this was created | Date/Time created | The date/time stamp of when this was created | DateControl | |||||||
| meta.createId | STRING | 1 to 36 | Creator ID | Principal ID of person who created this | Creator ID | ID assigned to the principal the user used to sign on to the system |
validation.noWhitespace ^[\x21-\x7E\t\r\n\v\f\s]*$ |
TextControl | ||||||
| meta.updateTime | DATE | must be 19 | Updated on | The date/time stamp of when this was last updated | Date/Time last updated | The date/time stamp of when this was last updated | DateControl | |||||||
| meta.updateId | STRING | 1 to 36 | Updater ID | Principal ID of person who last updated this | Updater ID | ID assigned to the principal the user used to sign on to the system |
validation.noWhitespace ^[\x21-\x7E\t\r\n\v\f\s]*$ |
TextControl | ||||||
| descr | Complex | Descr | A description of the entity. | Description | A description of the entity. | |||||||||
| descr.plain | STRING | 1 to 14000 | Plain Text | The plain text version of the descrpition | Plain Text Description | The plain text version of the descrpition |
validation.noWhitespace ^[\x21-\x7E\t\r\n\v\f\s]*$ |
TextAreaControl | ||||||
| descr.formatted | STRING | 1 to 14000 | Fromatted Text | The formatted text version of the descrpition | Fromatted Text Description | The formatted text version of the descrpition |
validation.noWhitespace ^[\x21-\x7E\t\r\n\v\f\s]*$ |
TextAreaControl | ||||||
| meta | Complex | Meta | Create and last update info for the structure. | Create/Update meta info | 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. | |||||||||
| meta.versionInd | STRING | 1 to 80 | Version Ind | Optimistic Locking Flag | Version Ind | Field used to check optimistic locking, updated on each update |
validation.noWhitespace ^[\x21-\x7E\t\r\n\v\f\s]*$ |
TextControl | ||||||
| meta.createTime | DATE | must be 19 | Created on | The date/time stamp of when this was created | Date/Time created | The date/time stamp of when this was created | DateControl | |||||||
| meta.createId | STRING | 1 to 36 | Creator ID | Principal ID of person who created this | Creator ID | ID assigned to the principal the user used to sign on to the system |
validation.noWhitespace ^[\x21-\x7E\t\r\n\v\f\s]*$ |
TextControl | ||||||
| meta.updateTime | DATE | must be 19 | Updated on | The date/time stamp of when this was last updated | Date/Time last updated | The date/time stamp of when this was last updated | DateControl | |||||||
| meta.updateId | STRING | 1 to 36 | Updater ID | Principal ID of person who last updated this | Updater ID | ID assigned to the principal the user used to sign on to the system |
validation.noWhitespace ^[\x21-\x7E\t\r\n\v\f\s]*$ |
TextControl |