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

AtpInfo

Name	atpInfo
Label	Atp
JSTL Key	AtpInfo
Java Class	org.kuali.student.r2.core.atp.dto.AtpInfo
Description	Information about an Academic Time Period.
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]*$
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.\-]*$
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]*$
code		STRING	1 to 80	Code	Gets a display code for this ATP.	Code	Gets a display code for this ATP.	validation.alphanumericPattern ^[A-Za-z0-9.\-]*$
startDate	required	DATE	must be 19	Start Date	Date and time the academic time period became effective.	Start Date	Date and time the academic time period became effective. This does not provide a bound on date ranges or milestones associated with this time period, but instead indicates the time period proper. This is a similar concept to the effective date on enumerated values. When an expiration date has been specified, this field must be less than or equal to the expiration date.
endDate	required	DATE	must be 19	End Date	Date and time the academic time period expires.	End Date	Date and time the academic time period expires. This does not provide a bound on date ranges or milestones associated with this time period, but instead indicates the time period proper. If specified, this must be greater than or equal to the effective date. If this field is not specified, then no expiration date has been currently defined and should automatically be considered greater than the effective date.
adminOrgId		STRING	1 to 36	Admin Org Id	The adminsitrative organization responsible for maintaining this time period.	AdminOrg Id	The adminsitrative organization responsible for maintaining this time period.	validation.anyCharacterPattern ^[\x21-\x7E\t\v\040\f\r\n]*$
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]*$