CluInfo

Name CluInfo
Usage CluService
getClu getClusByIds getClusByLuType getClusByRelatedCluAndRelationType getRelatedClusByCluAndRelationType getClusFromCluSet getAllClusInCluSet validateClu createClu updateClu createNewCluVersion updateCluState
CluSetTreeViewInfo
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  
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  
descr Description RichTextInfo Narrative description of the CLU, used for the catalog.     One No  
officialIdentifier Official Identifier CluIdentifierInfo Information related to the official identification of the clu, typically
in human readable form. Used to officially reference or publish.		 Required Read only One No  
alternateIdentifiers Alternate Identifiers CluIdentifierInfoList Information related to alternate identifications of the clu, typically in
human readable form. Used to reference or publish.		   Read only Many No  
studySubjectArea Study Subject Area String The Study Subject Area is used to identify the area of study associated
with the clu. It may be a general study area (e.g. Chemistry) or very
specific (e.g. Naval Architecture) depending on the level of specificity
of the clu.		     One No  
campusLocations Campus Location Keys StringList Places where this clu might be offered     Many No  
accreditations Accreditations AccreditationInfoList Information around the accreditation of the clu.     Many No  
adminOrgs Admin Orgs AdminOrgInfoList Admin Orgs associated with this clu     Many No  
primaryInstructor Primary Instructor CluInstructorInfo Primary potential instructor for the clu. This is primarily for use in
advertising the clu and may not be the actual instructor.		     One No  
instructors Instructors CluInstructorInfoList Instructors associated with this clu. This may not be an exhaustive list,
and instead may only be used to indicate potential instructors in
publication.		     Many No  
expectedFirstAtp Expected First Atp String The expected first academic time period that this clu would be effective.
This may not reflect the first "real" academic time period for this clu.		     One No  
lastAtp Last Atp String The last academic time period that this clu would be effective.     One No  
lastAdmitAtp Last Admit Atp String The last academic time period that this clu would be available for
enrollment. This may not reflect the last "real" academic time period for
this clu.		     One No  
intensity Intensity AmountInfo ???     One No  
stdDuration Std Duration TimeAmountInfo The standard duration of the learning unit.     One No  
canCreateLui is Can Create Lui Boolean Indicates if the CLU can be used to instantiate LUIs (offerings).     One No  
referenceURL Reference URL String An URL for additional information about the CLU. This could be a
reference to a document which might in turn have references to other
documents (e.g. course syllabus provided by the faculty or department,
standard schedule of classes, etc.).		     One No  
luCodes Lu Codes LuCodeInfoList List of LU code info structures. These are structures so that many
different types of codes can be associated with the clu. This allows them
to be put into categories.		     Many No  
nextReviewPeriod Next Review Period String When the next review should be     One No  
isEnrollable is Enrollable Boolean Indicates if Luis generated from this Clu are intended to be enrolled in
by Students directly		     One No  
offeredAtpTypes Offered Atp Types StringList The academic time period types in which this CLU is typically offered.
Standard usage would equate to terms.		     Many No  
isHasEarlyDropDeadline is Has Early Drop Deadline Boolean Indicates if the CLU has an Early Drop Deadline (EDD). Certain courses
are designated as such to maximize access to courses that have
historically experienced high demand and high attrition. Default is
"false".		     One No  
defaultEnrollmentEstimate Default Enrollment Estimate int Default enrollment estimate for this CLU.     One No  
defaultMaximumEnrollment Default Maximum Enrollment int Default maximum enrollment for this CLU.     One No  
isHazardousForDisabledStudents is Hazardous For Disabled Students Boolean Indicates if the CLU may be hazardous for students with disabilities.
Would default to "false".		     One No  
feeInfo Fee Info CluFeeInfo Fee information associated with this CLU.     One No  
accountingInfo Account Info CluAccountingInfo Accounting information associated with this CLU.     One No  
versionInfo Version Info VersionInfo Version information associated with this CLU     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