home

ResultValueGroupInfo

Name ResultValueGroupInfo
Usage GradingService LRCService
getResultValueGroupByKey createResultValueGroup updateResultValueGroup validateResultGroup
Type Complex

Description

Detailed information about a result component.

Structure Definition

ShortName Name Type Description Cardinality XML Attribute? Implementation Notes
key Key String Unique key to this object. Unlike an Id this key can be explicitly set by the
application and is intended to be "somewhat" readable by a human.

A Key:

  • A Key is used when the actual value is important
  • A Key value might be kuali.org.School
  • A Key on occasion may be used or seen by an end user.
  • Keys are assumed to have the same values in different KS implementations
  • Key values are defined in configuration
  • Key values have significance in that they are referenced in Configuration
  • Key values are expected to be occasionally used in application code
 One Yes  
typeKey Type Key String Unique identifier for the type of this object. One Yes  
stateKey State Key String Unique identifier for the state of this object. One Yes  
name Name String A display name for this entity. One No  
descr Description RichText A description of the entity. One No  
resultValues Result Values StringList List of result values contained within the group. Examples are grades
like A, B,C etc. A valid ResultValueGroup would contain either a range or
more than one result value or a combination of both range and value(s)		 Many No  
effectiveDate Effective Date Date Date and time that this result component 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  
resultRankingPairs Result Ranking Pairs ResultRankingPairList Contains the list of possible discrete results in this group with their rankings,
the values in this group would be the ultimate set of results possible.		 Many No  
expirationDate Expiration Date Date Date and time that this result component 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  
id Id String Unique identifier for a result component. This is optional, due to the
identifier being set at the time of creation. Once the result component
has been created, this should be seen as required.		 One Yes  
resultValueRange Result Value Range ResultValueRange The range contained within this result value group. This is
optional and might not be present for some Result Value Groups		 One 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.		 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