home contract doc
(!) This page was automatically generated on Fri Dec 09 11:27:11 EST 2011

HoldInfo

Name	holdInfo
Label	Hold
JSTL Key	HoldInfo
Java Class	org.kuali.student.r2.core.hold.dto.HoldInfo
Description	Information about a Hold.
Primary Key(s)	id
Field to use as the title (or name)	name

Field Definitions

No discrepancies were found between the dictionary definition and the java object -- WARNING: take this with a grain of salt - the comparison does not dig into complex sub-objects nor collections so...

Field	Required?	DataType	Length	Short Label	Summary	Label	Description	Valid Characters	Default Control
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.noWhitespace ^[\x21-\x7E\t\r\n\v\f\s]*$	TextControl
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.\-]*$	TextControl
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.\-]*$	TextControl
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
issueKey	required	STRING	1 to 255	Issue Id	The Issue Key.	Issue Id	The Issue Key.	validation.noWhitespace ^[\x21-\x7E\t\r\n\v\f\s]*$	TextControl
personId	required	STRING	1 to 36	Person Id	The Id of the Person.	Person Id	The Id of the Person.	validation.noWhitespace ^[\x21-\x7E\t\r\n\v\f\s]*$	TextControl
isWarning		BOOLEAN		Is Warning	Indicates whether this hold is a warning or should result in a block.	is Warning	Indicates whether this hold is a warning or should result in a block.		CheckboxControl
isOverridable		BOOLEAN		Is Overridable	Indicates whether an exception can override this hold.	Is Overridable	Indicates whether an exception can override this hold.		CheckboxControl
effectiveDate	required	DATE	must be 19	Effective	Effective Date	Effective Date	The date the object became (will become) effective		DateControl
releasedDate		DATE	must be 10	Released Date	The date this hold was released, of null if not yet released.	Released Date	The date this hold was released, of null if not yet released.		DateControl
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