PopulationRuleInfo


Name populationRuleInfo
Label Population Rule
JSTL Key PopulationRuleInfo
Java Class org.kuali.student.r2.core.population.dto.PopulationRuleInfo
Description Information about a Population Rule to set up a Population. Each "rule" defined in this interface adds to the population. The Population Rule Type determines the "operator" of how these elements are combined.
Primary Key(s) id
Field to use as the title (or name) name

Field Definitions

5 discrepancie(s) were found between the dictionary definition and the java object
  1. Field searchCriteria.countFlag.flag does not exist in the corresponding java class
  2. Field searchCriteria.countFlag missing from the dictictionary
  3. Field state missing from the dictictionary
  4. Field type missing from the dictictionary
  5. Field searchCriteria.predicate 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.\-]*$ 		     
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]*$ 		     
referencePopulationId   STRING 1 to 255 Reference Population Id The Population Id to be used as the reference population from which the child populations are removed in the minus operation. Reference Population Id The Population Id to be used as the reference population from which the child populations are removed in the minus operation. This is used only in the minus operation to help calculate "all others not caught but the any of the above" use case.       validation.anyCharacterPattern
^[\x21-\x7E\t\v\040\f\r\n]*$ 		     
variesByTime   BOOLEAN   Varies By Time Tests to see if the Population may vary by time. Varies By Time Tests to see if the Population may vary by time. If true then the response to isMemberAtXXXX getMembersAtXXXX methods should be used to assess membership because it is highly likely the population would return a different result depending on the time parameter that is supplied. An example of populations that vary by time include freshman, sophomore, junior, senior, etc... because the answer varies greatly depending on the term in question. Some examples of populations that are not expected to vary with time are males or students with IDs ending in an odd number or US citizens. Note: Saying that a population does not vary with time does not mean that the population does not change over time. Rather it means that calls isMember and isMemberAtXXX methods or getMembers and getMembersAtXXX should normally return the same answer if invoked simultaneously.              
supportsGetMembers   BOOLEAN   Supports Get Members Tests to see if this Population supports the getting of an explicit list of the members in this population. Supports Get Members Tests to see if this Population supports the getting of an explicit list of the members in this population. Not all populations need to support this method and only support the isMember method which tests. If false then calls to the getMembersXXX family for this population should throw an OperationFailedException exception.              
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]*$ 		     
searchCriteria.startAtIndex   INTEGER 1 to 10 Start At Index ??? Start At Index ???       validation.validChars.positive.integer
[1-9][0-9]* 		     
searchCriteria.maxResults   INTEGER 1 to 10 Max Results ??? Max Results ???       validation.validChars.positive.integer
[1-9][0-9]* 		     
searchCriteria.countFlag.flag   STRING 1 to 255 Flag ??? Flag ???       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]*$ 		     
searchCriteria   Complex   Search Criteria The search criteria to be used in building this population. *** NOT IMPLEMENTED ***** TODO: Figure out how this can be persisted Search Criteria The search criteria to be used in building this population. *** NOT IMPLEMENTED ***** TODO: Figure out how this can be persisted              
searchCriteria.startAtIndex   INTEGER 1 to 10 Start At Index ??? Start At Index ???       validation.validChars.positive.integer
[1-9][0-9]* 		     
searchCriteria.maxResults   INTEGER 1 to 10 Max Results ??? Max Results ???       validation.validChars.positive.integer
[1-9][0-9]* 		     
searchCriteria.countFlag.flag   STRING 1 to 255 Flag ??? Flag ???       validation.anyCharacterPattern
^[\x21-\x7E\t\v\040\f\r\n]*$ 		     
searchCriteria.predicate   Complex   Predicate ??? Predicate ???              
searchCriteria.countFlag   Complex   Count Flag ??? Count Flag ???              
searchCriteria.countFlag.flag   STRING 1 to 255 Flag ??? Flag ???       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]*$