InstructionInfo


Name instructionInfo
Label Instruction
JSTL Key InstructionInfo
Java Class org.kuali.student.r2.core.process.dto.InstructionInfo
Description Information about an Instruction. An Instruction is a Relationship between a Process and a Check. Instructions contain a set of applied data that determines if the Check applies to a Process. To determine if a Check applies to a Process: 1. the person is a member of any applied Populations 2. and the current ATP type is any of the applied ATP Types If any of the above applied elements is empty, then the applied element evaluates to true. If all applied elements are empty, then the Check is globally applied.
Primary Key(s) id
Field to use as the title (or name) null

Field Definitions

2 discrepancie(s) were found between the dictionary definition and the java object
  1. Field state missing from the dictictionary
  2. Field type missing from the dictictionary
Field Required? DataType Length Short Label Summary Label Description Read Only, Dynamic, or Hidden Default Repeats? Valid Characters Lookup Cross Field 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.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.\-]*$ 		     
effectiveDate required DATE must be 19 Effective Effective Date Effective Date The date the object became (will become) effective              
expirationDate   DATE must be 19 Expires Expiration Date Expiration Date The date the object became (will) expire              
processKey required STRING 1 to 255 Process Key The process key. Process Key The process key.       validation.anyCharacterPattern
^[\x21-\x7E\t\v\040\f\r\n]*$ 		     
checkId required STRING 1 to 255 Check Id The Check Id. Check Id The Check Id.       validation.anyCharacterPattern
^[\x21-\x7E\t\v\040\f\r\n]*$ 		     
appliedPopulationId   STRING 1 to 255 Applied Population Id The Population Id to which the Check applies. Applied Population Id The Population Id to which the Check applies. Check notes on https://wiki.kuali.org/display/STUDENT/SVCS+20120605       validation.anyCharacterPattern
^[\x21-\x7E\t\v\040\f\r\n]*$ 		     
position   INTEGER 1 to 10 Position The position in the Process. Position The position in the Process.       validation.validChars.positive.integer
[1-9][0-9]* 		     
isWarning   BOOLEAN   Is Warning Tests if a failure in this Check results in warning or failure for this step. Is Warning Tests if a failure in this Check results in warning or failure for this step. If true, the Check failure is interpreted as a warning. If false, the Check failure is interpreted as an error.              
continueOnFail   BOOLEAN   Continue On Fail Tests if processing should continue if this Check fails. Continue On Fail Tests if processing should continue if this Check fails.              
isExemptible   BOOLEAN   Is Exemptible Tests an Exemption can be requested to this Instruction. Is Exemptable Tests an Exemption can be requested to this Instruction.              
message.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]*$ 		     
message.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]*$ 		     
message   Complex   Message The text of a message to display to a user on fail or warning for this Instruction. Message The text of a message to display to a user on fail or warning for this Instruction. (todo: substituting variables to create contextual message and handling internationalization)              
message.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]*$ 		     
message.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]*$