PopulationInfo

Name PopulationInfo
Usage PopulationService
getPopulation getPopulationsByIds getPopulationsForPopulationRule searchForPopulations validatePopulation createPopulation updatePopulation
Type Complex

Description

Information about a Population.

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  
sortOrderTypeKeys Sort Order Type Keys StringList Gets the valid sort order keys that can be used to sort the
members of the Population.

The valid sort order keys correspond
to the underlying rule sorting capabilities.

This may return an empty list indicating the population does
not support any particular ordering.		   Read only calculation surfacing the corresponding field from the underlying rule Many No  
variesByTime Varies By Time Boolean Tests to see if the Population may vary by time.

If true then the response to isMemberAtXXXX getMembersAtXXXX
methods should be used to assess membership because it is
highly likely the population would return a different result
depending on the time parameter that is supplied.

An example of populations that vary by time include freshman,
sophomore, junior, senior, etc... because the answer varies
greatly depending on the term in question.

Some examples of populations that are not expected to vary with
time are males or students with IDs ending in an odd number or
US citizens.

Note: Saying that a population does not vary with time does not
mean that the population does not change over time. Rather it
means that calls isMember and isMemberAtXXX methods or
getMembers and getMembersAtXXX should normally return the same
answer if invoked simultaneously.		   Read only calculation surfacing the corresponding field from the underlying rule One No  
supportsGetMembers Supports Get Members Boolean Tests to see if this Population supports the getting of an
explicit list of the members in this population.

Not all populations need to support this method and only
support the isMember method which tests.

If false then calls to the getMembersXXX family for this
population should throw an OperationFailedException exception.		   Read only calculation surfacing the corresponding field from the underlying rule 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