OrgPositionRestrictionInfo

Name OrgPositionRestrictionInfo
Usage OrganizationService
getOrgPositionRestriction getOrgPositionRestrictionsByIds searchForOrgPositionRestrictions validateOrgPositionRestriction createOrgPositionRestriction updateOrgPositionRestriction
Type Complex

Description

Information which constrains/describes organization to person
relationships of a particular type for an organization. These
constraints/descriptions typically involve active relationships.

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  
orgId Org Id String Organization the restriction applies to.   Read only One No  
orgPersonRelationTypeKey Organization Person Relation Type Key String Organization to person relationship type the restriction
applies to.		 Required Read only One No  
title Title String Title of organization person relationships of this type. This allows for
distinction from the name of the relationship type itself, specific for
the given organization.		     One No  
descr Description RichTextInfo Description of the restrictions and use of the relationship type within
this particular organization. This should primarily focus on deviations
from the standard use of the relationship type.		     One No  
stdDuration Standard Duration TimeAmountInfo Describes the standard duration of relationships of this type.     One No  
minNumRelations Minimum Number of Relations Integer Acts as a lower bound on the number of relationships of this
type expected for the organization. If specified, this should
be less than or equal to the value of maxNumRelations. This
number must be greater than or equal to zero.		     One No  
maxNumRelations Maximum Number of Relations String Acts as an upper bound on the number of relationships of this type
expected for the organization. The values of this field are restricted
to integer values and the string "unbounded". If specified,
this should be greater than or equal to the value of minNumRelations,
with the value "unbounded" being automatically assumed to be greater.		     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