ExemptionInfo

Name ExemptionInfo
Usage ExemptionService
getExemption getExemptionsByIds validateExemption createExemption updateExemption getExemptionsForPerson getExemptionsForRequest getActiveExemptionsForPerson getExemptionsByTypeForPerson getActiveExemptionsByTypeForPerson getActiveExemptionsByTypeProcessAndCheckForPerson
Type Complex

Description

Information about an Exemption.

Extra data qualifies the exemption to a particular scope, such as for a
particular Course or Program.

There can only be one override structure per exemption. The
override structure available in this Exemption is constrained by
the Exemption Type.

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  
exemptionRequestId Exemption Request Id String The Id of the Exemption Request. Required Read only One No  
processKey Process Id String The id of a Process that is being exempted in the
the exemption is applied.

Together with the check this identifies which instruction(s) to skip or
or data to be overridden when the process is being evaluated.		     One No  
checkId Check Id String The Id of a Check that indicates to what Check in the Process
the exemption is applied.		     One No  
personId Person Id String The Id of the Person who was exempted.

This is the same as the person id on the request.		 Required Read only One No on creates this should be copied from the request and stored on the exemption
effectiveDate Effective Date Date The date this exemption becomes effective.

If not supplied it should default to today's date.		     One No  
expirationDate Expiration Date Date The date this exemption expires.     One No  
useLimit Use Limit Integer The number of times this Exemption may be used.

Should be a positive integer or left null to indicate there is no limit.		     One No  
useCount Use Count Integer The number of times this Exemption was marked as used.

Null means that it has not been used or is not being tracked because there is
no corresponding limit.		     One No  
dateOverride Date Override DateOverrideInfo The data for a date override.     One No  
milestoneOverride Milestone Override MilestoneOverrideInfo The data for a milestone override.     One No  
learningResultOverride Learning Result Override LearningResultOverrideInfo The data for a learning result override.     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