ResultValuesGroupInfo

Name ResultValuesGroupInfo
Usage CourseService LRCService
getCreateFixedCreditResultValuesGroup getCreateRangeCreditResultValuesGroup getCreateMultipleCreditResultValuesGroup getResultValuesGroup getResultValuesGroupsByKeys getResultValuesGroupsByResultValue getResultValuesGroupsByResultScale createResultValuesGroup updateResultValuesGroup validateResultValuesGroup getResultValuesGroupsByResultScaleType
CourseInfo
Type Complex

Description

Detailed information about a group of result values.

This grouping can be expressed two ways:
(1) as an explicit list of values, i.e. A, B, C, etc
(2) as a range of numeric values 1-100 with .01 increments

It may also combine the two approaches. (3) A numeric range for a
grade 1-100 but also allow for grades like I for incomplete.

Note: This object has been renamed from R1, previously it was
called ResultComponent.

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 The scale to which this group belongs. Result Values mapped to
a Result Values Group belong to a single Result Scale.		     One No  
resultValueKeys Result Value Keys StringList Contains the list of discrete results value keys in this group.     Many No  
resultValueRange Result Value Range ResultValueRangeInfo The range contained within this result value group. This is
optional and might not be present for some Result Components		     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