home
contract doc
Maven Release: 1.3.0-services-SNAPSHOT
Page Generated: 2012-08-28 01:35 EDT

RegistrationRequestItemInfo

Name	registrationRequestItemInfo
Label	Registration Request Item
JSTL Key	RegistrationRequestItemInfo
Java Class	org.kuali.student.enrollment.courseregistration.dto.RegistrationRequestItemInfo
Description	Represents a single transaction item for a Student and Registration Group. The possible types of RegistrationRequestItem are ADD, DROP, SWAP or UPDATE. These types represent adding (waitlisting, holdlisting), dropping courses, swapping sections, or changing the registration options. The Transaction Item Type indicates if this is for an ADD, DROP, SWAP or UPDATE. 1. Register for course - RegistrationRequestItem Type is ADD, newRegistrationGroupId is the RegistrationGroup. 2. Register for course but waitlist if seat not available OR waitlist for course - same as above and okToWaitlist is true. 3. Swap between RegistrationGroup within same CourseOffering - Type is SWAP, both new and existing RegistrationGroup Ids populated. New RegistrationGroup is to be the one replaced with the old one. RegistrationGroups are in the same CourseOffering.
Primary Key(s)	id
Field to use as the title (or name)	name

Field Definitions

2 discrepancie(s) were found between the dictionary definition and the java object

Field state missing from the dictictionary
Field type missing from the dictictionary

Field	Required?	DataType	Length	Short Label	Summary	Label	Description	Valid Characters
id		STRING	1 to 36	ID	Unique ID assigned to this object	Identifier	The system assigned unique id used to identify this Object. Could be implemented as as sequence number or as a UUID.	validation.anyCharacterPattern ^[\x21-\x7E\t\v\040\f\r\n]*$
name		STRING	1 to 255	Name	A display name for this entity.	Name	A display name for this entity.	validation.anyCharacterPattern ^[\x21-\x7E\t\v\040\f\r\n]*$
typeKey	required	STRING	1 to 80	Type	Type of the object	Type	Unique identifier for the type of this object.	validation.alphanumericPattern ^[A-Za-z0-9.\-]*$
stateKey	required	STRING	1 to 80	State	State of the object	State	Unique identifier for the lifecycle state of this object.	validation.alphanumericPattern ^[A-Za-z0-9.\-]*$
registrationRequestId		STRING	1 to 255	Registration Request Id	The RegistrationRequest to which this item belongs.	Registration Request Id	The RegistrationRequest to which this item belongs.	validation.anyCharacterPattern ^[\x21-\x7E\t\v\040\f\r\n]*$
studentId	required	STRING	1 to 255	Student Id	The Student to which this request item applies.	Student Id	The Student to which this request item applies.	validation.anyCharacterPattern ^[\x21-\x7E\t\v\040\f\r\n]*$
newRegistrationGroupId		STRING	1 to 255	New Registration Group Id	The RegistrationGroup to which the student will be registered upon a successful submission of this item.	Registration Group Id	The RegistrationGroup to which the student will be registered upon a successful submission of this item. This is populated for ADD, DROP, UPDATE and SWAP types of RegistrationRequestItems.	validation.anyCharacterPattern ^[\x21-\x7E\t\v\040\f\r\n]*$
existingRegistrationGroupId		STRING	1 to 255	Existing Registration Group Id	In the case of a DROP or SWAP, the "existing" registration group Id indicates the current RegistrationGroup to which the student is currently registered.	Existing Registration Group Id	In the case of a DROP or SWAP, the "existing" registration group Id indicates the current RegistrationGroup to which the student is currently registered. For an ADD, this field should be null.	validation.anyCharacterPattern ^[\x21-\x7E\t\v\040\f\r\n]*$
credits		STRING	1 to 255	Credits	The desired number of credits.	Credits	The desired number of credits. This value is a number represented as a string.	validation.anyCharacterPattern ^[\x21-\x7E\t\v\040\f\r\n]*$
gradingOptionId		STRING	1 to 255	Grading Option Id	The requested grading scheme option (e.g.	Grading Option Id	The requested grading scheme option (e.g. A-F or Pass/Fail).	validation.anyCharacterPattern ^[\x21-\x7E\t\v\040\f\r\n]*$
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.
okToHoldUntilList		BOOLEAN		Ok To Hold Until 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 HoldUntillist	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.
descr.plain		STRING	1 to 999	Plain Text	The plain text version of the descrpition	Plain Text Description	The plain text version of the descrpition	validation.anyCharacterPattern ^[\x21-\x7E\t\v\040\f\r\n]*$
descr.formatted		STRING	1 to 999	Fromatted Text	The formatted text version of the descrpition	Fromatted Text Description	The formatted text version of the descrpition	validation.anyCharacterPattern ^[\x21-\x7E\t\v\040\f\r\n]*$
meta.versionInd		STRING	1 to 80	Version Ind	Optimistic Locking Flag	Version Ind	Field used to check optimistic locking, updated on each update	validation.anyCharacterPattern ^[\x21-\x7E\t\v\040\f\r\n]*$
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
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.anyCharacterPattern ^[\x21-\x7E\t\v\040\f\r\n]*$
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
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.anyCharacterPattern ^[\x21-\x7E\t\v\040\f\r\n]*$
descr		Complex		Descr	A description of the entity.	Description	A description of the entity.
descr.plain		STRING	1 to 999	Plain Text	The plain text version of the descrpition	Plain Text Description	The plain text version of the descrpition	validation.anyCharacterPattern ^[\x21-\x7E\t\v\040\f\r\n]*$
descr.formatted		STRING	1 to 999	Fromatted Text	The formatted text version of the descrpition	Fromatted Text Description	The formatted text version of the descrpition	validation.anyCharacterPattern ^[\x21-\x7E\t\v\040\f\r\n]*$
meta		Complex		Meta	Create and last update info for the structure.	Meta	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.anyCharacterPattern ^[\x21-\x7E\t\v\040\f\r\n]*$
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
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.anyCharacterPattern ^[\x21-\x7E\t\v\040\f\r\n]*$
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
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.anyCharacterPattern ^[\x21-\x7E\t\v\040\f\r\n]*$