ResultValueInfo

Name ResultValueInfo
Usage GradingService LRCService
getCreateResultValueForScale getResultValue getResultValuesByKeys getResultValuesForResultValuesGroup createResultValue updateResultValue validateResultValue getResultValuesForScale getResultValueForScaleAndValue getResultValuesForResultValuesGroups
GradeValuesGroupInfo
Type Complex

Description

A Result Value.

Structure Definition

ShortName Name Type Description Required? Read only? 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



Once an object is created with the specified key it cannot be
changed. Instead the object must be deleted or in-activated and
a new object created with the right key.		 Required on updates Read only on updates 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  
resultScaleKey Result Scale Key String Identifier of the scale for this result value.     One No  
numericValue Numeric Value String A numeric value used to ranking or order this result value
within the scale.

For Grades it holds the quality points, i.e. A=4.0, B=3.0. For
credits it holds the actual numeric credits. For degrees it is
used to indicate perhaps how many years of study it typically
takes to achieve that degree.		     One No  
value Result value String Result Value string Value of the result. Typically corresponds
with the short coded form of the result (ex. "A", "4.0",
"97.0", "B.S" etc.) scaleKey Scale Identifier scaleKey.		     One No  
effectiveDate Effective Date Date Date/time this object became effective. Must be less than or
equal to the expirationDate specified.		     One No  
expirationDate Expiration Date Date Date/time this relationship is no longer effective. Must be
greater than or equal to the effectiveDate specified.		     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