home

ResultValueRange

Name ResultValueRange
Usage CourseOfferingService
ResultValuesGroup
Type Complex

Description

Captures the legal value range for a result component

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
     One No  
minValue Min Value Float Min Result Value string Lower end of the value range. Typically corresponds with the short coded form of the
result(ex. "1.0", "25.0" etc.) Should the data resultTypeKey of values (min/max) be numbers and not Strings in the
value range?		     One No  
maxValue Max Value Float Max Result Value string Upper end of the value range. Typically corresponds with the short coded form of the
result(ex. "3.0", "100.0" etc.). Upper end can be left empty to indicate unbounded upper end.		     One No  
increment Increment Float Increment number Legal increments in the result values. This has to be a decimal e.g 0.5)     One No  
effectiveDate Effective Date Date Effective Date dateTime Date and time that this result value range became effective. 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.		     One No  
expirationDate Expiration Date Date Expiration Date dateTime Date and time that this result value range expires. This is a similar concept to the
expiration date on enumerated values. If specified, this should 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.		     One No  
attributes Dynamic Attributes AttributeList 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  
meta Create/Update meta info 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.		 Required on updates Read only One No