CluSetInfo

Name CluSetInfo
Usage CluService
getCluSet getCluSetsByIds validateCluSet createCluSet updateCluSet
Type Complex

Description

Copyright 2010 The Kuali Foundation Licensed under the
Educational Community License, Version 2.0 (the "License"); you may
not use this file except in compliance with the License. You may
obtain a copy of the License at

http://www.osedu.org/licenses/ECL-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an "AS IS"
BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
or implied. See the License for the specific language governing
permissions and limitations under the License.

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  
descr Description RichTextInfo A description of the entity.     One No  
stateKey State Key String A unique identifier for the state of this object. Required   One Yes  
typeKey Type Key String A unique identifier for the type of this object. Required Read only One Yes  
name Name String A display name for this entity.     One No  
membershipQuery Membership Query MembershipQueryInfo Specifies a search for CLU identifiers. Present for dynamic CLU Sets     One No  
adminOrg Admin Org String Information about an organization acting in administrative capacity for a
learning unit.The Organization responsible for this cluset		     One No  
isReusable Is Reusable Boolean Flags if the Clu Set is reusable or was created for one time use for e.g.
in ReqComponentInfo		     One No  
isReferenceable Is Referenceable Boolean Flags set to true if CluSet can be referenced by ReqComponets and other
entities. If set to false, then the CluSet can be referenced only by
other CluSets.		     One No  
cluSetIds Clu Set Ids StringList List of identifiers of directly contained CLU Sets. Present for
enumerated CLU Sets.		   Read only Many No  
cluIds Clu Ids StringList List of identifiers of directly contained CLUs. Present for enumerated
CLU Sets.		   Read only Many 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