CheckInfo

Name CheckInfo
Usage ProcessService
getCheck getChecksByIds searchForChecks validateCheck createCheck updateCheck
Type Complex

Description

Information about a Check. A Check can be one of a:

1. Hold Check: the Issue Id is not null
2. Deadline Check: the Milestone Type Key and Atp Type Key are
not null
3. Not Before Check: the Milestone Type Key and Atp Type Key are
not null
4. In Time Period Check: the Milestone Type Key and Atp Type
Key are not null
5. Outside Date Range Check: the Milestone Type Key and Atp
Type Key are not null
6. Statement Check: the Statement Id is not null
7. Process Check: the Process key is not null

Structure Definition

ShortName Name Type Description Required? Read only? Cardinality XML Attribute? Implementation Notes
id Unique Id String The system assigned unique id to identify this Object.
Could be implemented as as sequence number or as a UUID.

Attempts to set this value on creates should result in a ReadOnlyException being thrown

An Id:

  • An id is used when the actual value is unimportant and
    can therefore be a large hex value for example

  • An id value might be 23b9ca9bd203df902

  • An Id is never intended to be used directly by an end
    user.

  • Ids are assumed to be of different values in different
    KS implementations

  • Id values are generated by the service
    implementations

  • Id values are never expected to be used in
    Configuration or Application code

 Required on updates Read only One Yes  
typeKey Type Key String A unique identifier for the type of this object. Required Read only One Yes  
stateKey State Key String A unique identifier for the state of this object. Required   One Yes  
name Name String A display name for this entity.     One No  
descr Description RichTextInfo A description of the entity.     One No  
holdIssueId Hold Issue Id String The Hold Issue if this Check to check if the student has an applied hold.     One No  
milestoneTypeKey Milestone Type Key String The Milestone Type Key if this Check is for a deadline, "not
before," "in time period" or "outside date range" checks.		     One No  
agendaId Agenda Id String The Agenda Id if this Check is based on evaluating
an Agenda. (do we need a reference for the eval?)		     One No  
childProcessKey Child Process Key String The Process Key if this Check is to evaluate a all the instructions
already defined in another child process.		     One No  
rightComparisonValue Right Comparison Value String A hard coded value for comparison Check Types of
min/max/equals. The left comparison value may be determined
from the context of the process or from an agenda Id.

For example, this value may indicate a hard-coded credit limit
per term for all students. The Check may be that the current
load does not exceed this hard coded value.		     One No  
leftComparisonAgendaId Left Comparison Agenda Id String The Left Comparison Agenda Id is for comparison Check Types of
min/max/equals for determining the left-hand side of the
comparison.

For example, this rule evaluation may determine the current
credit load for a particular student in a Term to compare it
with a credit limit as determined by getRightComparisonValue()
or an evaluation resulting from getRightComparisonAgendaId().		     One No  
rightComparisonAgendaId Right Comparison Agenda Id String The Right Comparison Agenda Id is for comparison Check Types of
min/max/equals for determining the right-hand side of the
comparison.

For example, the result of this rule evaluation may calculate
the credit limit for a particular student if it fluctuates by
other criteria such as Term or Population.		     One No  
meta Meta MetaInfo 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.		 Required on updates Read only One No  
attributes Dynamic Attributes AttributeInfoList List of dynamic attributes, each holding a key-value pair that
can be configured to hold additional information for an
implementing institution.

Note: the key may be repeated more than once to simulate a list
of values.		     Many No