CluService (Kuali Student 2.0.0-M8-SNAPSHOT API)

All Superinterfaces:

SearchService, VersionManagementService

All Known Implementing Classes:

CluServiceImpl, CluServiceMockImpl
```
public interface CluService
extends VersionManagementService, SearchService
```
Learning Unit (LU) Service

Version:

2.0

Method Summary

Methods
Modifier and Type	Method and Description
`StatusInfo`	`addCluResourceRequirement(String resourceTypeKey, String cluId, ContextInfo contextInfo)` Add a Resource requirement to a CLU
`StatusInfo`	`addCluSetsToCluSet(String cluSetId, List<String> addedCluSetIds, ContextInfo contextInfo)` Adds a list of CLU sets to another CluSet.
`StatusInfo`	`addCluSetToCluSet(String cluSetId, String addedCluSetId, ContextInfo contextInfo)` Adds one CLU set to another
`StatusInfo`	`addClusToCluSet(List<String> cluSetIds, String cluSetId, ContextInfo contextInfo)` Adds a list of CLUs to a CLU set.
`StatusInfo`	`addCluToCluSet(String cluId, String cluSetId, ContextInfo contextInfo)` Add a CLU to a CLU set
`CluInfo`	`createClu(String luTypeKey, CluInfo cluInfo, ContextInfo contextInfo)` Creates a new CLU
`CluCluRelationInfo`	`createCluCluRelation(String cluId, String relatedCluId, String cluCluRelationTypeKey, CluCluRelationInfo cluCluRelationInfo, ContextInfo contextInfo)` Create a directional relationship between two CLUs
`CluLoRelationInfo`	`createCluLoRelation(String cluId, String loId, String cluLoRelationTypeKey, CluLoRelationInfo cluLoRelationInfo, ContextInfo contextInfo)` Creates a relationship between a learning objective and a CLU.
`CluPublicationInfo`	`createCluPublication(String cluId, String luPublicationTypeKey, CluPublicationInfo cluPublicationInfo, ContextInfo contextInfo)` Create a clu publication object, which contains information about publication for a clu.
`CluResultInfo`	`createCluResult(String cluId, String cluResultTypeKey, CluResultInfo cluResultInfo, ContextInfo contextInfo)` Create a clu result object, which contains information about potential results for a clu.
`CluSetInfo`	`createCluSet(String cluSetTypeKey, CluSetInfo cluSetInfo, ContextInfo contextInfo)` Creates a CLU set.
`CluInfo`	`createNewCluVersion(String cluId, String versionComment, ContextInfo contextInfo)` Creates a new CLU version based on the current clu
`StatusInfo`	`deleteClu(String cluId, ContextInfo contextInfo)` Deletes an existing CLU
`StatusInfo`	`deleteCluCluRelation(String cluCluRelationId, ContextInfo contextInfo)` Deletes a relationship between two CLUs
`StatusInfo`	`deleteCluLoRelation(String cluLoRelationId, ContextInfo contextInfo)` Removes a relationship between a learning objective and a Clu.
`StatusInfo`	`deleteCluPublication(String cluPublicationId, ContextInfo contextInfo)` Deletes an existing clu publication object
`StatusInfo`	`deleteCluResult(String cluResultId, ContextInfo contextInfo)` Deletes an existing clu result
`StatusInfo`	`deleteCluSet(String cluSetId, ContextInfo contextInfo)` Delete a CLU set
`List<String>`	`getAllCluIdsInCluSet(String cluSetId, ContextInfo contextInfo)` Retrieves the list of CLU Identifiers within a CLU Set or any cluset that is included within that.
`List<CluInfo>`	`getAllClusInCluSet(String cluSetId, ContextInfo contextInfo)` Retrieves the full list of CLUs in this CLU set or any cluset that is included within that.
`List<String>`	`getAllowedCluCluRelationTypesByClu(String cluId, String relatedCluId, ContextInfo contextInfo)` Retrieves the list of allowed relation types between the two specified CLUs
`List<String>`	`getAllowedCluLoRelationTypesForLuType(String luTypeKey, ContextInfo contextInfo)` Retrieves the list of CLU LO relation types which are allowed to be used in conjunction with an lu type.
`List<String>`	`getAllowedLuLuRelationTypesForLuType(String luTypeKey, String relatedLuTypeKey, ContextInfo contextInfo)` Retrieves the list of allowed relation types between the two specified LU Types
`List<String>`	`getAllowedResultComponentTypesForResultUsageType(String resultUsageTypeKey, ContextInfo contextInfo)` Retrieves the list of result component types which are allowed to be used in conjunction with result usage type.
`List<String>`	`getAllowedResultUsageTypesForLuType(String luTypeKey, ContextInfo contextInfo)` Retrieves the list of result usage types which are allowed to be used in conjunction with an lu type.
`CluInfo`	`getClu(String cluId, ContextInfo contextInfo)` Retrieves core information about a CLU
`CluCluRelationInfo`	`getCluCluRelation(String cluCluRelationId, ContextInfo contextInfo)` Retrieves the relationship information between CLUs for a particular Relation instance
`List<CluCluRelationInfo>`	`getCluCluRelationsByClu(String cluId, ContextInfo contextInfo)` Retrieves the list of relationship information for the specified CLU
`List<TypeInfo>`	`getCluCluRelationTypes(ContextInfo contextInfo)` Retrieves the complete list of LU to LU relation types
`List<String>`	`getCluIdsByLuType(String luTypeKey, String luState, ContextInfo contextInfo)` Retrieves the list of CLU Ids for the specified LU Type and state
`List<String>`	`getCluIdsByRelatedCluAndRelationType(String relatedCluId, String cluCluRelationTypeKey, ContextInfo contextInfo)` Retrieves the list of CLU Ids for the specified related CLU Id and LU to LU relation type (getRelatedCluIdsByCluAndRelationType from the other direction)
`List<String>`	`getCluIdsByResultComponent(String resultComponentId, ContextInfo contextInfo)` Retrieves the list of clu Ids which use a particular result component
`List<String>`	`getCluIdsByResultUsageType(String resultUsageTypeKey, ContextInfo contextInfo)` Retrieves the list of clu Ids with the results of the specified usage type.
`List<String>`	`getCluIdsFromCluSet(String cluSetId, ContextInfo contextInfo)` Retrieves the list of CLU Identifiers within a CLU Set.
`CluLoRelationInfo`	`getCluLoRelation(String cluLoRelationId, ContextInfo contextInfo)` Retrieve information on a CLU LO Relation.
`List<CluLoRelationInfo>`	`getCluLoRelationsByClu(String cluId, ContextInfo contextInfo)` Retrieves the list of canonical learning unit to learning objective relationships for a given CLU.
`List<CluLoRelationInfo>`	`getCluLoRelationsByLo(String loId, ContextInfo contextInfo)` Retrieves the list of CLU identifiers associated with a given learning objective identifier.
`TypeInfo`	`getCluLoRelationType(String cluLoRelationTypeKey, ContextInfo contextInfo)` Retrieves information for a specified CLU to LO relation type
`List<TypeInfo>`	`getCluLoRelationTypes(ContextInfo contextInfo)` Retrieves the complete list of CLU to LO relation types
`CluPublicationInfo`	`getCluPublication(String cluPublicationId, ContextInfo contextInfo)` Retrieves an LU publication object by its identifier
`List<CluPublicationInfo>`	`getCluPublicationsByClu(String cluId, ContextInfo contextInfo)` Retrieves a list of publication objects for a particular clu
`List<CluPublicationInfo>`	`getCluPublicationsByType(String luPublicationTypeKey, ContextInfo contextInfo)` Retrieves a list of publication objects of a particular Type
`CluResultInfo`	`getCluResult(String cluResultId, ContextInfo contextInfo)` Retrieves information about a Clu Result
`List<CluResultInfo>`	`getCluResultByClu(String cluId, ContextInfo contextInfo)` Retrieves the cluResult for a particular clu
`List<CluResultInfo>`	`getCluResultsByClus(List<String> cluIds, ContextInfo contextInfo)` Retrieves the list of cluResults for the cluIds specified
`TypeInfo`	`getCluResultType(String cluResultTypeKey, ContextInfo contextInfo)` Retrieves information about a publication type
`List<TypeInfo>`	`getCluResultTypes(ContextInfo contextInfo)` Retrieves a list of types for clu result objects.
`List<TypeInfo>`	`getCluResultTypesForLuType(String luTypeKey, ContextInfo contextInfo)` Retrieves the list of clu result types which are allowed to be used in conjunction with a particular lu type.
`List<CluInfo>`	`getClusByIds(List<String> cluIds, ContextInfo contextInfo)` Retrieves information about CLUs from a list of Ids
`List<CluInfo>`	`getClusByLuType(String luTypeKey, String luState, ContextInfo contextInfo)` Retrieves the list of CLUs for the specified LU Type and state
`List<CluInfo>`	`getClusByRelatedCluAndRelationType(String relatedCluId, String cluCLuRelationTypeKey, ContextInfo contextInfo)` Retrieves the list of CLU information for the CLUs related to a specified CLU Id with a certain LU to LU relation type (getRelatedClusByClu from the other direction)
`CluSetInfo`	`getCluSet(String cluSetId, ContextInfo contextInfo)` Retrieve information on a CLU set.
`List<String>`	`getCluSetIdsFromCluSet(String cluSetId, ContextInfo contextInfo)` Retrieve the list of CLU Set Ids within a CLU Set
`List<CluSetInfo>`	`getCluSetsByIds(List<String> cluSetIds, ContextInfo contextInfo)` Retrieve information on CLU sets from a list of cluSet Ids.
`CluSetTreeViewInfo`	`getCluSetTreeView(String cluSetId, ContextInfo contextInfo)` Retrieve information on a CLU set and its sub clu set fully expanded.
`TypeInfo`	`getCluSetType(String cluSetTypeKey, ContextInfo contextInfo)` Retrieves information about a specified CLU set type
`List<TypeInfo>`	`getCluSetTypes(ContextInfo contextInfo)` Retrieves the list of CLU set types known by the service
`List<CluInfo>`	`getClusFromCluSet(String cluSetId, ContextInfo contextInfo)` Retrieves the list of CLUs in a CLU set.
`TypeInfo`	`getDeliveryMethodType(String deliveryMethodTypeKey, ContextInfo contextInfo)` Retrieves information about a delivery method type
`List<TypeInfo>`	`getDeliveryMethodTypes(ContextInfo contextInfo)` Retrieves the list of delivery method types
`TypeInfo`	`getInstructionalFormatType(String instructionalFormatTypeKey, ContextInfo contextInfo)` Retrieves information about a Instructional Format Type
`List<TypeInfo>`	`getInstructionalFormatTypes(ContextInfo contextInfo)` Retrieves the list of instructional format types
`TypeInfo`	`getLuCodeType(String luCodeTypeKey, ContextInfo contextInfo)` Retrieves information about a learning unit code type
`List<TypeInfo>`	`getLuCodeTypes(ContextInfo contextInfo)` Retrieves the list of learning unit code types
`TypeInfo`	`getLuLuRelationType(String cluCluRelationTypeKey, ContextInfo contextInfo)` Retrieves the LU to LU relation type
`TypeInfo`	`getLuPublicationType(String luPublicationTypeKey, ContextInfo contextInfo)` Retrieves information about a publication type
`List<TypeInfo>`	`getLuPublicationTypes(ContextInfo contextInfo)` Retrieves the list of Learning Unit publication types
`List<String>`	`getLuPublicationTypesForLuType(String luTypeKey, ContextInfo contextInfo)` Retrieves information about a publication type
`TypeInfo`	`getLuType(String luTypeKey, ContextInfo contextInfo)` Retrieves information about a LU Type
`List<TypeInfo>`	`getLuTypes(ContextInfo contextInfo)` Retrieves the list of LU types
`List<String>`	`getRelatedCluIdsByCluAndRelationType(String cluId, String cluCluRelationTypeKey, ContextInfo contextInfo)` Retrieves the list of related CLU Ids for the specified CLU Id and LU to LU relation type (getCluIdsByRelatedCluAndCluCluRelationType from the other direction)
`List<CluInfo>`	`getRelatedClusByCluAndRelationType(String cluId, String cluCluRelationTypeKey, ContextInfo contextInfo)` Retrieves the list of related CLU information for the specified CLU Id and LU to LU relation type (getClusByRelation from the other direction)
`List<String>`	`getResourceRequirementsForClu(String cluId, ContextInfo contextInfo)` Retrieves the list of Resource requirements for the specified CLU
`TypeInfo`	`getResultUsageType(String resultUsageTypeKey, ContextInfo contextInfo)` Retrieves information about a Result Usage Type
`List<TypeInfo>`	`getResultUsageTypes(ContextInfo contextInfo)` Retrieves a list of result usage types
`Boolean`	`isCluInCluSet(String cluId, String cluSetId, ContextInfo contextInfo)` Checks if a CLU is a member of a CLU set or any contained CLU set
`Boolean`	`isCluSetDynamic(String cluSetId, ContextInfo contextInfo)` Check if the given CluSet is dynamic
`StatusInfo`	`removeCluFromCluSet(String cluId, String cluSetId, ContextInfo contextInfo)` Remove a CLU from a CLU set
`StatusInfo`	`removeCluResourceRequirement(String resourceTypeKey, String cluId, ContextInfo contextInfo)` Remove a Resource requirement from a CLU
`StatusInfo`	`removeCluSetFromCluSet(String cluSetId, String removedCluSetId, ContextInfo contextInfo)` Removes one CLU set from another
`List<String>`	`searchForCluCluRelationIds(QueryByCriteria criteria, ContextInfo contextInfo)` Search for CluCluRelation Ids using free form search criteria
`List<CluCluRelationInfo>`	`searchForCluCluRelations(QueryByCriteria criteria, ContextInfo contextInfo)` Search for CluCluRelations using free form search criteria
`List<String>`	`searchForCluIds(QueryByCriteria criteria, ContextInfo contextInfo)` Search for Clu Ids using free form search criteria
`List<String>`	`searchForCluLoRelationIds(QueryByCriteria criteria, ContextInfo contextInfo)` Search for CluLoRelation Ids using free form search criteria
`List<CluLoRelationInfo>`	`searchForCluLoRelations(QueryByCriteria criteria, ContextInfo contextInfo)` Search for CluLoRelations using free form search criteria.
`List<String>`	`searchForCluPublicationIds(QueryByCriteria criteria, ContextInfo contextInfo)` Search for CluPublication Ids using free form search criteria
`List<CluPublicationInfo>`	`searchForCluPublications(QueryByCriteria criteria, ContextInfo contextInfo)` Search for CluPublications using free form search criteria
`List<String>`	`searchForCluResultIds(QueryByCriteria criteria, ContextInfo contextInfo)` Search for CluResult Ids using free form search criteria
`List<CluResultInfo>`	`searchForCluResults(QueryByCriteria criteria, ContextInfo contextInfo)` Search for CluResults using free form search criteria
`List<CluInfo>`	`searchForClus(QueryByCriteria criteria, ContextInfo contextInfo)` Search for Clus using free form search criteria.
`StatusInfo`	`setCurrentCluVersion(String cluVersionId, Date currentVersionStart, ContextInfo contextInfo)` Sets a specific version of the Clu as current.
`CluInfo`	`updateClu(String cluId, CluInfo cluInfo, ContextInfo contextInfo)` Updates an existing CLU
`CluCluRelationInfo`	`updateCluCluRelation(String cluCluRelationId, CluCluRelationInfo cluCluRelationInfo, ContextInfo contextInfo)` Updates a relationship between two CLUs
`CluLoRelationInfo`	`updateCluLoRelation(String cluLoRelationId, CluLoRelationInfo cluLoRelationInfo, ContextInfo contextInfo)` Updates a relationship between a clu and learning objective
`CluPublicationInfo`	`updateCluPublication(String cluPublicationId, CluPublicationInfo cluPublicationInfo, ContextInfo contextInfo)` Updates an existing clu publication object
`CluResultInfo`	`updateCluResult(String cluResultId, CluResultInfo cluResultInfo, ContextInfo contextInfo)` Updates an existing clu result
`CluSetInfo`	`updateCluSet(String cluSetId, CluSetInfo cluSetInfo, ContextInfo contextInfo)` Update the information for a CLU set
`CluInfo`	`updateCluState(String cluId, String luState, ContextInfo contextInfo)` Updates the state of the specified CLU
`List<ValidationResultInfo>`	`validateClu(String validationTypeKey, CluInfo cluInfo, ContextInfo contextInfo)` Validates a CLU.
`List<ValidationResultInfo>`	`validateCluCluRelation(String validationTypeKey, String cluId, String relatedCluId, String cluCluRelationTypeKey, CluCluRelationInfo cluCluRelationInfo, ContextInfo contextInfo)` Validates a cluCluRelation.
`List<ValidationResultInfo>`	`validateCluLoRelation(String validationTypeKey, String cluId, String loId, String cluLoRelationTypeKey, CluLoRelationInfo cluLoRelationInfo, ContextInfo contextInfo)` Validates a cluLoRelation.
`List<ValidationResultInfo>`	`validateCluPublication(String validationTypeKey, String cluId, String luPublicationTypeKey, CluPublicationInfo cluPublicationInfo, ContextInfo contextInfo)` Validates information about publication for a clu.
`List<ValidationResultInfo>`	`validateCluResult(String validationTypeKey, String cluId, String cluResultTypeKey, CluResultInfo cluResultInfo, ContextInfo contextInfo)` Validates information about results for a clu.
`List<ValidationResultInfo>`	`validateCluSet(String validationTypeKey, String cluSetTypeKey, CluSetInfo cluSetInfo, ContextInfo contextInfo)` Validates information about a clu set.

Methods inherited from interface org.kuali.student.r2.core.versionmanagement.service.VersionManagementService
getCurrentVersion, getCurrentVersionOnDate, getFirstVersion, getLatestVersion, getVersionBySequenceNumber, getVersions, getVersionsInDateRange

Methods inherited from interface org.kuali.student.r2.core.search.service.SearchService
getSearchType, getSearchTypes, search

- Method Detail
  - getDeliveryMethodTypes
```
List<TypeInfo> getDeliveryMethodTypes(ContextInfo contextInfo)
                                      throws InvalidParameterException,
                                             MissingParameterException,
                                             OperationFailedException,
                                             PermissionDeniedException
```
    Retrieves the list of delivery method types
    
    Parameters:
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    list of delivery method type information
    
    Throws:
    
    InvalidParameterException - invalid contextInfo
    
    MissingParameterException - missing contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
  - getDeliveryMethodType
```
TypeInfo getDeliveryMethodType(String deliveryMethodTypeKey,
                             ContextInfo contextInfo)
                               throws DoesNotExistException,
                                      InvalidParameterException,
                                      MissingParameterException,
                                      OperationFailedException,
                                      PermissionDeniedException
```
    Retrieves information about a delivery method type
    
    Parameters:
    deliveryMethodTypeKey - Key of the Delivery Method Type
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    information about a Delivery Method Type
    
    Throws:
    
    DoesNotExistException - deliveryMethodType not found
    
    InvalidParameterException - invalid contextInfo
    
    MissingParameterException - missing deliveryMethodType or contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
  - getInstructionalFormatTypes
```
List<TypeInfo> getInstructionalFormatTypes(ContextInfo contextInfo)
                                           throws InvalidParameterException,
                                                  MissingParameterException,
                                                  OperationFailedException,
                                                  PermissionDeniedException
```
    Retrieves the list of instructional format types
    
    Parameters:
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    list of instructional format type information
    
    Throws:
    
    InvalidParameterException - invalid contextInfo
    
    MissingParameterException - missing contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
  - getInstructionalFormatType
```
TypeInfo getInstructionalFormatType(String instructionalFormatTypeKey,
                                  ContextInfo contextInfo)
                                    throws DoesNotExistException,
                                           InvalidParameterException,
                                           MissingParameterException,
                                           OperationFailedException,
                                           PermissionDeniedException
```
    Retrieves information about a Instructional Format Type
    
    Parameters:
    instructionalFormatTypeKey - Key of the Instructional Format Type
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    information about a Instructional Format Type
    
    Throws:
    
    DoesNotExistException - instructionalFormatTypeKey not found
    
    InvalidParameterException - invalid contextInfo
    
    MissingParameterException - missing instructionalFormatTypeKey or contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
  - getLuTypes
```
List<TypeInfo> getLuTypes(ContextInfo contextInfo)
                          throws InvalidParameterException,
                                 MissingParameterException,
                                 OperationFailedException,
                                 PermissionDeniedException
```
    Retrieves the list of LU types
    
    Parameters:
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    list of LU type information
    
    Throws:
    
    InvalidParameterException - invalid contextInfo
    
    MissingParameterException - missing contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
  - getLuType
```
TypeInfo getLuType(String luTypeKey,
                 ContextInfo contextInfo)
                   throws DoesNotExistException,
                          InvalidParameterException,
                          MissingParameterException,
                          OperationFailedException,
                          PermissionDeniedException
```
    Retrieves information about a LU Type
    
    Parameters:
    luTypeKey - Key of the LU Type
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    information about a LU Type
    
    Throws:
    
    DoesNotExistException - luTypeKey not found
    
    InvalidParameterException - invalid contextInfo
    
    MissingParameterException - missing luTypeKey or contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
  - getLuCodeTypes
```
List<TypeInfo> getLuCodeTypes(ContextInfo contextInfo)
                              throws InvalidParameterException,
                                     MissingParameterException,
                                     OperationFailedException,
                                     PermissionDeniedException
```
    Retrieves the list of learning unit code types
    
    Parameters:
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    list of lu code type information
    
    Throws:
    
    InvalidParameterException - invalid contextInfo
    
    MissingParameterException - missing contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
  - getLuCodeType
```
TypeInfo getLuCodeType(String luCodeTypeKey,
                     ContextInfo contextInfo)
                       throws DoesNotExistException,
                              InvalidParameterException,
                              MissingParameterException,
                              OperationFailedException,
                              PermissionDeniedException
```
    Retrieves information about a learning unit code type
    
    Parameters:
    luCodeTypeKey - Key of the learning unit code type
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    information about a learning unit code type
    
    Throws:
    
    DoesNotExistException - luCodeTypeKey not found
    
    InvalidParameterException - invalid contextInfo
    
    MissingParameterException - missing luCodeTypeKey or contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
  - getCluCluRelationTypes
```
List<TypeInfo> getCluCluRelationTypes(ContextInfo contextInfo)
                                      throws InvalidParameterException,
                                             MissingParameterException,
                                             OperationFailedException,
                                             PermissionDeniedException
```
    Retrieves the complete list of LU to LU relation types
    
    Parameters:
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    list of LU to LU relation type information
    
    Throws:
    
    InvalidParameterException - invalid contextInfo
    
    MissingParameterException - missing contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
  - getLuLuRelationType
```
TypeInfo getLuLuRelationType(String cluCluRelationTypeKey,
                           ContextInfo contextInfo)
                             throws DoesNotExistException,
                                    InvalidParameterException,
                                    MissingParameterException,
                                    OperationFailedException,
                                    PermissionDeniedException
```
    Retrieves the LU to LU relation type
    
    Parameters:
    cluCluRelationTypeKey - Key of the LU to LU Relation Type
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    LU to LU relation type information
    
    Throws:
    
    DoesNotExistException - cluCluRelationTypeKey not found
    
    InvalidParameterException - invalid contextInfo
    
    MissingParameterException - missing cluCluRelationTypeKey or contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
  - getAllowedLuLuRelationTypesForLuType
```
List<String> getAllowedLuLuRelationTypesForLuType(String luTypeKey,
                                                String relatedLuTypeKey,
                                                ContextInfo contextInfo)
                                                  throws DoesNotExistException,
                                                         InvalidParameterException,
                                                         MissingParameterException,
                                                         OperationFailedException,
                                                         PermissionDeniedException
```
    Retrieves the list of allowed relation types between the two specified LU Types
    
    Parameters:
    luTypeKey - Key of the first LU Type
    relatedLuTypeKey - Key of the second LU Type
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    list of LU to LU relation types
    
    Throws:
    
    DoesNotExistException - luTypeKey, relatedLuTypeKey not found
    
    InvalidParameterException - invalid contextInfo
    
    MissingParameterException - missing luTypeKey, relatedLuTypeKey or contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
  - getLuPublicationTypes
```
List<TypeInfo> getLuPublicationTypes(ContextInfo contextInfo)
                                     throws InvalidParameterException,
                                            MissingParameterException,
                                            OperationFailedException,
                                            PermissionDeniedException
```
    Retrieves the list of Learning Unit publication types
    
    Parameters:
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    list of Learning Unit publication type information
    
    Throws:
    
    InvalidParameterException - invalid contextInfo
    
    MissingParameterException - missing contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
  - getLuPublicationType
```
TypeInfo getLuPublicationType(String luPublicationTypeKey,
                            ContextInfo contextInfo)
                              throws DoesNotExistException,
                                     InvalidParameterException,
                                     MissingParameterException,
                                     OperationFailedException,
                                     PermissionDeniedException
```
    Retrieves information about a publication type
    
    Parameters:
    luPublicationTypeKey - Key of the Learning Unit Publication Type
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    information about a Learning Unit Publication Type
    
    Throws:
    
    DoesNotExistException - luPublicationTypeKey not found
    
    InvalidParameterException - invalid contextInfo
    
    MissingParameterException - missing luPublicationTypeKey or contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
  - getLuPublicationTypesForLuType
```
List<String> getLuPublicationTypesForLuType(String luTypeKey,
                                          ContextInfo contextInfo)
                                            throws DoesNotExistException,
                                                   InvalidParameterException,
                                                   MissingParameterException,
                                                   OperationFailedException,
                                                   PermissionDeniedException
```
    Retrieves information about a publication type
    
    Parameters:
    luTypeKey - Key of the LU Type
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    list of LU publication types
    
    Throws:
    
    DoesNotExistException - luTypeKey not found
    
    InvalidParameterException - invalid contextInfo
    
    MissingParameterException - missing luTypeKey or contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
  - getCluResultTypes
```
List<TypeInfo> getCluResultTypes(ContextInfo contextInfo)
                                 throws InvalidParameterException,
                                        MissingParameterException,
                                        OperationFailedException,
                                        PermissionDeniedException
```
    Retrieves a list of types for clu result objects.
    
    Parameters:
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    list of clu result type information
    
    Throws:
    
    InvalidParameterException - invalid contextInfo
    
    MissingParameterException - missing contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
  - getCluResultType
```
TypeInfo getCluResultType(String cluResultTypeKey,
                        ContextInfo contextInfo)
                          throws DoesNotExistException,
                                 InvalidParameterException,
                                 MissingParameterException,
                                 OperationFailedException,
                                 PermissionDeniedException
```
    Retrieves information about a publication type
    
    Parameters:
    cluResultTypeKey - Key of the Canonical Learning Unit Result Type
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    information about a Learning Unit Publication Type
    
    Throws:
    
    DoesNotExistException - cluResultTypeKey not found
    
    InvalidParameterException - invalid contextInfo
    
    MissingParameterException - missing cluResultTypeKey or contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
  - getCluResultTypesForLuType
```
List<TypeInfo> getCluResultTypesForLuType(String luTypeKey,
                                        ContextInfo contextInfo)
                                          throws DoesNotExistException,
                                                 InvalidParameterException,
                                                 MissingParameterException,
                                                 OperationFailedException,
                                                 PermissionDeniedException
```
    Retrieves the list of clu result types which are allowed to be used in conjunction with a particular lu type.
    
    Parameters:
    luTypeKey - luTypeKey
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    list of clu result types
    
    Throws:
    
    DoesNotExistException - luTypeKey not found
    
    InvalidParameterException - invalid contextInfo
    
    MissingParameterException - missing luTypeKey or contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
  - getResultUsageTypes
```
List<TypeInfo> getResultUsageTypes(ContextInfo contextInfo)
                                   throws InvalidParameterException,
                                          MissingParameterException,
                                          OperationFailedException,
                                          PermissionDeniedException
```
    Retrieves a list of result usage types
    
    Parameters:
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    list of result usage type information
    
    Throws:
    
    InvalidParameterException - invalid contextInfo
    
    MissingParameterException - missing contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
  - getResultUsageType
```
TypeInfo getResultUsageType(String resultUsageTypeKey,
                          ContextInfo contextInfo)
                            throws DoesNotExistException,
                                   InvalidParameterException,
                                   MissingParameterException,
                                   OperationFailedException,
                                   PermissionDeniedException
```
    Retrieves information about a Result Usage Type
    
    Parameters:
    resultUsageTypeKey - Key of the Result Usage Type
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    information about a Result Usage Type
    
    Throws:
    
    DoesNotExistException - resultUsageTypeKey not found
    
    InvalidParameterException - invalid contextInfo
    
    MissingParameterException - missing resultUsageTypeKey or contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
  - getAllowedResultUsageTypesForLuType
```
List<String> getAllowedResultUsageTypesForLuType(String luTypeKey,
                                               ContextInfo contextInfo)
                                                 throws DoesNotExistException,
                                                        InvalidParameterException,
                                                        MissingParameterException,
                                                        OperationFailedException,
                                                        PermissionDeniedException
```
    Retrieves the list of result usage types which are allowed to be used in conjunction with an lu type.
    
    Parameters:
    luTypeKey - luTypeKey
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    list of result usage types
    
    Throws:
    
    DoesNotExistException - luTypeKey not found
    
    InvalidParameterException - invalid contextInfo
    
    MissingParameterException - missing luTypeKey or contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
  - getAllowedResultComponentTypesForResultUsageType
```
List<String> getAllowedResultComponentTypesForResultUsageType(String resultUsageTypeKey,
                                                            ContextInfo contextInfo)
                                                              throws DoesNotExistException,
                                                                     InvalidParameterException,
                                                                     MissingParameterException,
                                                                     OperationFailedException,
                                                                     PermissionDeniedException
```
    Retrieves the list of result component types which are allowed to be used in conjunction with result usage type.
    
    Parameters:
    resultUsageTypeKey - resultUsageTypeKey
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    list of result component types
    
    Throws:
    
    DoesNotExistException - resultUsageTypeKey not found
    
    InvalidParameterException - invalid contextInfo
    
    MissingParameterException - missing resultUsageTypeKey or contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
  - getCluLoRelationTypes
```
List<TypeInfo> getCluLoRelationTypes(ContextInfo contextInfo)
                                     throws InvalidParameterException,
                                            MissingParameterException,
                                            OperationFailedException,
                                            PermissionDeniedException
```
    Retrieves the complete list of CLU to LO relation types
    
    Parameters:
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    list of CLU to LO relation type information
    
    Throws:
    
    InvalidParameterException - invalid contextInfo
    
    MissingParameterException - missing contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
  - getCluLoRelationType
```
TypeInfo getCluLoRelationType(String cluLoRelationTypeKey,
                            ContextInfo contextInfo)
                              throws DoesNotExistException,
                                     InvalidParameterException,
                                     MissingParameterException,
                                     OperationFailedException,
                                     PermissionDeniedException
```
    Retrieves information for a specified CLU to LO relation type
    
    Parameters:
    cluLoRelationTypeKey - Key of the CLU to LO Relation Type
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    CLU to LO relation type information
    
    Throws:
    
    DoesNotExistException - cluLoRelationTypeKey not found
    
    InvalidParameterException - invalid contextInfo
    
    MissingParameterException - missing cluLoRelationTypeKey or contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
  - getAllowedCluLoRelationTypesForLuType
```
List<String> getAllowedCluLoRelationTypesForLuType(String luTypeKey,
                                                 ContextInfo contextInfo)
                                                   throws DoesNotExistException,
                                                          InvalidParameterException,
                                                          MissingParameterException,
                                                          OperationFailedException,
                                                          PermissionDeniedException
```
    Retrieves the list of CLU LO relation types which are allowed to be used in conjunction with an lu type.
    
    Parameters:
    luTypeKey - luTypeKey
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    list of clu lo relation types
    
    Throws:
    
    DoesNotExistException - luTypeKey not found
    
    InvalidParameterException - invalid contextInfo
    
    MissingParameterException - missing luTypeKey or contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
  - getCluSetTypes
```
List<TypeInfo> getCluSetTypes(ContextInfo contextInfo)
                              throws InvalidParameterException,
                                     MissingParameterException,
                                     OperationFailedException,
                                     PermissionDeniedException
```
    Retrieves the list of CLU set types known by the service
    
    Parameters:
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    list of CLU set type information
    
    Throws:
    
    InvalidParameterException - invalid contextInfo
    
    MissingParameterException - missing contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
  - getCluSetType
```
TypeInfo getCluSetType(String cluSetTypeKey,
                     ContextInfo contextInfo)
                       throws DoesNotExistException,
                              InvalidParameterException,
                              MissingParameterException,
                              OperationFailedException,
                              PermissionDeniedException
```
    Retrieves information about a specified CLU set type
    
    Parameters:
    cluSetTypeKey - Key of the CLU set type
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    information about a CLU set type
    
    Throws:
    
    DoesNotExistException - cluSetTypeKey not found
    
    InvalidParameterException - invalid contextInfo
    
    MissingParameterException - missing cluSetTypeKey or contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
  - getClu
```
CluInfo getClu(String cluId,
             ContextInfo contextInfo)
               throws DoesNotExistException,
                      InvalidParameterException,
                      MissingParameterException,
                      OperationFailedException,
                      PermissionDeniedException
```
    Retrieves core information about a CLU
    
    Parameters:
    cluId - identifier of the CLU
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    information about a CLU
    
    Throws:
    
    DoesNotExistException - cluId not found
    
    InvalidParameterException - invalid contextInfo
    
    MissingParameterException - missing cluId or contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
  - getClusByIds
```
List<CluInfo> getClusByIds(List<String> cluIds,
                         ContextInfo contextInfo)
                           throws DoesNotExistException,
                                  InvalidParameterException,
                                  MissingParameterException,
                                  OperationFailedException,
                                  PermissionDeniedException
```
    Retrieves information about CLUs from a list of Ids
    
    Parameters:
    cluIds - List of CLU identifiers
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    information a list of CLUs
    
    Throws:
    
    DoesNotExistException - One or more cluIds not found
    
    InvalidParameterException - invalid contextInfo
    
    MissingParameterException - missing cluIds or contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
  - getClusByLuType
```
List<CluInfo> getClusByLuType(String luTypeKey,
                            String luState,
                            ContextInfo contextInfo)
                              throws DoesNotExistException,
                                     InvalidParameterException,
                                     MissingParameterException,
                                     OperationFailedException,
                                     PermissionDeniedException
```
    Retrieves the list of CLUs for the specified LU Type and state
    
    Parameters:
    luTypeKey - Type of the CLUs to retrieve
    luState - State of the CLUs to retrieve.
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    list of CLU information
    
    Throws:
    
    DoesNotExistException - luTypeKey or luState not found
    
    InvalidParameterException - invalid contextInfo
    
    MissingParameterException - missing luTypeKey, luState or contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
  - getCluIdsByLuType
```
List<String> getCluIdsByLuType(String luTypeKey,
                             String luState,
                             ContextInfo contextInfo)
                               throws DoesNotExistException,
                                      InvalidParameterException,
                                      MissingParameterException,
                                      OperationFailedException,
                                      PermissionDeniedException
```
    Retrieves the list of CLU Ids for the specified LU Type and state
    
    Parameters:
    luTypeKey - Type of the CLUs whose identifiers should be retrieved
    luState - State of the CLUs whose identifiers should be retrieved
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    list of CLU identifiers
    
    Throws:
    
    DoesNotExistException - luType or luState not found
    
    InvalidParameterException - invalid contextInfo
    
    MissingParameterException - missing luType, luState or contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
  - getAllowedCluCluRelationTypesByClu
```
List<String> getAllowedCluCluRelationTypesByClu(String cluId,
                                              String relatedCluId,
                                              ContextInfo contextInfo)
                                                throws DoesNotExistException,
                                                       InvalidParameterException,
                                                       MissingParameterException,
                                                       OperationFailedException,
                                                       PermissionDeniedException
```
    Retrieves the list of allowed relation types between the two specified CLUs
    
    Parameters:
    cluId - identifier of the first CLU
    relatedCluId - identifier of the second CLU
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    list of LU to LU relation types
    
    Throws:
    
    DoesNotExistException - cluId, relatedCluId not found
    
    InvalidParameterException - invalid contextInfo
    
    MissingParameterException - missing cluId, relatedCluId or contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
  - getClusByRelatedCluAndRelationType
```
List<CluInfo> getClusByRelatedCluAndRelationType(String relatedCluId,
                                               String cluCLuRelationTypeKey,
                                               ContextInfo contextInfo)
                                                 throws DoesNotExistException,
                                                        InvalidParameterException,
                                                        MissingParameterException,
                                                        OperationFailedException,
                                                        PermissionDeniedException
```
    Retrieves the list of CLU information for the CLUs related to a specified CLU Id with a certain LU to LU relation type (getRelatedClusByClu from the other direction)
    
    Parameters:
    relatedCluId - identifier of the child or To CLU
    cluCLuRelationTypeKey - the LU to LU relation type
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    list of CLU information
    
    Throws:
    
    DoesNotExistException - relatedCluId, cluCLuRelationTypeKey not found
    
    InvalidParameterException - invalid contextInfo
    
    MissingParameterException - missing relatedCluId, cluCLuRelationTypeKey or contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
  - getCluIdsByRelatedCluAndRelationType
```
List<String> getCluIdsByRelatedCluAndRelationType(String relatedCluId,
                                                String cluCluRelationTypeKey,
                                                ContextInfo contextInfo)
                                                  throws DoesNotExistException,
                                                         InvalidParameterException,
                                                         MissingParameterException,
                                                         OperationFailedException,
                                                         PermissionDeniedException
```
    Retrieves the list of CLU Ids for the specified related CLU Id and LU to LU relation type (getRelatedCluIdsByCluAndRelationType from the other direction)
    
    Parameters:
    relatedCluId - identifier of the child or To CLU
    cluCluRelationTypeKey - the LU to LU relation type
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    list of CLU identifiers
    
    Throws:
    
    DoesNotExistException - relatedCluId or cluCluRelationTypeKey not found
    
    InvalidParameterException - invalid contextInfo
    
    MissingParameterException - missing relatedCluId, cluCluRelationTypeKey or contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
  - getRelatedClusByCluAndRelationType
```
List<CluInfo> getRelatedClusByCluAndRelationType(String cluId,
                                               String cluCluRelationTypeKey,
                                               ContextInfo contextInfo)
                                                 throws DoesNotExistException,
                                                        InvalidParameterException,
                                                        MissingParameterException,
                                                        OperationFailedException,
                                                        PermissionDeniedException
```
    Retrieves the list of related CLU information for the specified CLU Id and LU to LU relation type (getClusByRelation from the other direction)
    
    Parameters:
    cluId - identifier of the parent or From CLU
    cluCluRelationTypeKey - the LU to LU relation type
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    list of CLU information
    
    Throws:
    
    DoesNotExistException - cluId or cluCluRelationTypeKey not found
    
    InvalidParameterException - invalid contextInfo
    
    MissingParameterException - missing cluId, cluCluRelationTypeKey or contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
  - getRelatedCluIdsByCluAndRelationType
```
List<String> getRelatedCluIdsByCluAndRelationType(String cluId,
                                                String cluCluRelationTypeKey,
                                                ContextInfo contextInfo)
                                                  throws DoesNotExistException,
                                                         InvalidParameterException,
                                                         MissingParameterException,
                                                         OperationFailedException,
                                                         PermissionDeniedException
```
    Retrieves the list of related CLU Ids for the specified CLU Id and LU to LU relation type (getCluIdsByRelatedCluAndCluCluRelationType from the other direction)
    
    Parameters:
    cluId - identifier of the parent or From CLU
    cluCluRelationTypeKey - the LU to LU relation type
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    list of CLU identifiers
    
    Throws:
    
    DoesNotExistException - cluId, cluCluRelationTypeKey not found
    
    InvalidParameterException - invalid contextInfo
    
    MissingParameterException - missing cluId, cluCluRelationTypeKey
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
  - getCluCluRelation
```
CluCluRelationInfo getCluCluRelation(String cluCluRelationId,
                                   ContextInfo contextInfo)
                                     throws DoesNotExistException,
                                            InvalidParameterException,
                                            MissingParameterException,
                                            OperationFailedException,
                                            PermissionDeniedException
```
    Retrieves the relationship information between CLUs for a particular Relation instance
    
    Parameters:
    cluCluRelationId - identifier of the CLU to CLU relation
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    information on the relation between two CLUs
    
    Throws:
    
    DoesNotExistException - cluCluRelationId not found
    
    InvalidParameterException - invalid contextInfo
    
    MissingParameterException - missing cluCluRelationId or contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
  - getCluCluRelationsByClu
```
List<CluCluRelationInfo> getCluCluRelationsByClu(String cluId,
                                               ContextInfo contextInfo)
                                                 throws DoesNotExistException,
                                                        InvalidParameterException,
                                                        MissingParameterException,
                                                        OperationFailedException,
                                                        PermissionDeniedException
```
    Retrieves the list of relationship information for the specified CLU
    
    Parameters:
    cluId - identifier of the parent or From CLU
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    list of CLU to CLU relation information
    
    Throws:
    
    DoesNotExistException - cluId not found
    
    InvalidParameterException - invalid contextInfo
    
    MissingParameterException - missing cluId or contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
  - getCluPublicationsByClu
```
List<CluPublicationInfo> getCluPublicationsByClu(String cluId,
                                               ContextInfo contextInfo)
                                                 throws DoesNotExistException,
                                                        InvalidParameterException,
                                                        MissingParameterException,
                                                        OperationFailedException,
                                                        PermissionDeniedException
```
    Retrieves a list of publication objects for a particular clu
    
    Parameters:
    cluId - clu identifier
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    list of publication objects used by the specified clu
    
    Throws:
    
    DoesNotExistException - cluId not found
    
    InvalidParameterException - invalid contextInfo
    
    MissingParameterException - missing cluId or contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
  - getCluPublicationsByType
```
List<CluPublicationInfo> getCluPublicationsByType(String luPublicationTypeKey,
                                                ContextInfo contextInfo)
                                                  throws DoesNotExistException,
                                                         InvalidParameterException,
                                                         MissingParameterException,
                                                         OperationFailedException,
                                                         PermissionDeniedException
```
    Retrieves a list of publication objects of a particular Type
    
    Parameters:
    luPublicationTypeKey - luPublicationType identifier
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    list of CLU Publication objects using the specified type
    
    Throws:
    
    DoesNotExistException - luPublicationType not found
    
    InvalidParameterException - invalid contextInfo
    
    MissingParameterException - missing luPublicationTypeKey or contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
  - getCluPublication
```
CluPublicationInfo getCluPublication(String cluPublicationId,
                                   ContextInfo contextInfo)
                                     throws DoesNotExistException,
                                            InvalidParameterException,
                                            MissingParameterException,
                                            OperationFailedException,
                                            PermissionDeniedException
```
    Retrieves an LU publication object by its identifier
    
    Parameters:
    cluPublicationId - CLU publication identifier
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    CLU Publication information
    
    Throws:
    
    DoesNotExistException - cluPublicationId not found
    
    InvalidParameterException - invalid contextInfo
    
    MissingParameterException - missing cluPublicationId or contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
  - getCluResult
```
CluResultInfo getCluResult(String cluResultId,
                         ContextInfo contextInfo)
                           throws DoesNotExistException,
                                  InvalidParameterException,
                                  MissingParameterException,
                                  OperationFailedException,
                                  PermissionDeniedException
```
    Retrieves information about a Clu Result
    
    Parameters:
    cluResultId - identifier of the Clu Result
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    information about a Clu Result
    
    Throws:
    
    DoesNotExistException - cluResultId not found
    
    InvalidParameterException - invalid contextInfo
    
    MissingParameterException - missing cluResultId or contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
  - getCluResultByClu
```
List<CluResultInfo> getCluResultByClu(String cluId,
                                    ContextInfo contextInfo)
                                      throws DoesNotExistException,
                                             InvalidParameterException,
                                             MissingParameterException,
                                             OperationFailedException
```
    Retrieves the cluResult for a particular clu
    
    Parameters:
    cluId - clu identifier
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    result information for a clu
    
    Throws:
    
    DoesNotExistException - cluId not found
    
    InvalidParameterException - invalid contextInfo
    
    MissingParameterException - missing cluId or contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
  - getCluResultsByClus
```
List<CluResultInfo> getCluResultsByClus(List<String> cluIds,
                                      ContextInfo contextInfo)
                                        throws DoesNotExistException,
                                               InvalidParameterException,
                                               MissingParameterException,
                                               OperationFailedException
```
    Retrieves the list of cluResults for the cluIds specified
    
    Parameters:
    cluIds - list of clu identifier's
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    list of CluResults corresponding to the cluIds specified
    
    Throws:
    
    DoesNotExistException - one or more of the cludIds does not exist.
    
    InvalidParameterException - invalid contextInfo
    
    MissingParameterException - missing cluIds or contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
  - getCluIdsByResultUsageType
```
List<String> getCluIdsByResultUsageType(String resultUsageTypeKey,
                                      ContextInfo contextInfo)
                                        throws DoesNotExistException,
                                               InvalidParameterException,
                                               MissingParameterException,
                                               OperationFailedException
```
    Retrieves the list of clu Ids with the results of the specified usage type. This would for example allow requests for all clus which have a final grade.
    
    Parameters:
    resultUsageTypeKey - identifier of the result usage type
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    list of clu Ids
    
    Throws:
    
    DoesNotExistException - resultUsageType not found
    
    InvalidParameterException - invalid resultUsageTypeKey
    
    MissingParameterException - missing resultUsageTypeKey
    
    OperationFailedException - unable to complete request
  - getCluIdsByResultComponent
```
List<String> getCluIdsByResultComponent(String resultComponentId,
                                      ContextInfo contextInfo)
                                        throws DoesNotExistException,
                                               InvalidParameterException,
                                               MissingParameterException,
                                               OperationFailedException
```
    Retrieves the list of clu Ids which use a particular result component
    
    Parameters:
    resultComponentId - identifier of the result component
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    list of clu Ids
    
    Throws:
    
    DoesNotExistException - resultComponent not found
    
    InvalidParameterException - invalid resultComponentId
    
    MissingParameterException - missing resultComponentId
    
    OperationFailedException - unable to complete request
  - getCluLoRelation
```
CluLoRelationInfo getCluLoRelation(String cluLoRelationId,
                                 ContextInfo contextInfo)
                                   throws DoesNotExistException,
                                          InvalidParameterException,
                                          MissingParameterException,
                                          OperationFailedException,
                                          PermissionDeniedException
```
    Retrieve information on a CLU LO Relation.
    
    Parameters:
    cluLoRelationId - Identifier of the CLU LO Relation
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    The retrieved CLU LO Relation information
    
    Throws:
    
    DoesNotExistException - cluLoRelationId not found
    
    InvalidParameterException - invalid contextInfo
    
    MissingParameterException - missing cluLoRelationId or contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
  - getCluLoRelationsByClu
```
List<CluLoRelationInfo> getCluLoRelationsByClu(String cluId,
                                             ContextInfo contextInfo)
                                               throws DoesNotExistException,
                                                      InvalidParameterException,
                                                      MissingParameterException,
                                                      OperationFailedException,
                                                      PermissionDeniedException
```
    Retrieves the list of canonical learning unit to learning objective relationships for a given CLU.
    
    Parameters:
    cluId - Identifier for the CLU
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    List of canonical learning unit to learning objective relationships
    
    Throws:
    
    DoesNotExistException - cluId not found
    
    InvalidParameterException - invalid contextInfo
    
    MissingParameterException - missing cluId or contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
  - getCluLoRelationsByLo
```
List<CluLoRelationInfo> getCluLoRelationsByLo(String loId,
                                            ContextInfo contextInfo)
                                              throws DoesNotExistException,
                                                     InvalidParameterException,
                                                     MissingParameterException,
                                                     OperationFailedException,
                                                     PermissionDeniedException
```
    Retrieves the list of CLU identifiers associated with a given learning objective identifier.
    
    Parameters:
    loId - Identifier for the learning objective
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    List of CLU LO Relations
    
    Throws:
    
    DoesNotExistException - loId not found
    
    InvalidParameterException - invalid contextInfo
    
    MissingParameterException - missing loId or contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
  - getResourceRequirementsForClu
```
List<String> getResourceRequirementsForClu(String cluId,
                                         ContextInfo contextInfo)
                                           throws DoesNotExistException,
                                                  InvalidParameterException,
                                                  MissingParameterException,
                                                  OperationFailedException,
                                                  PermissionDeniedException
```
    Retrieves the list of Resource requirements for the specified CLU
    
    Parameters:
    cluId - Unique identifier for the CLU
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    List of resource requirements
    
    Throws:
    
    DoesNotExistException - cluId not found
    
    InvalidParameterException - invalid contextInfo
    
    MissingParameterException - missing cluId or contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
  - getCluSet
```
CluSetInfo getCluSet(String cluSetId,
                   ContextInfo contextInfo)
                     throws DoesNotExistException,
                            InvalidParameterException,
                            MissingParameterException,
                            OperationFailedException,
                            PermissionDeniedException
```
    Retrieve information on a CLU set. This information should be about the set itself, and in the case of a dynamic CLU set, should include the criteria used to generate the set.
    
    Parameters:
    cluSetId - Identifier of the CLU set
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    The retrieved CLU set information
    
    Throws:
    
    DoesNotExistException - cluSetId not found
    
    InvalidParameterException - invalid contextInfo
    
    MissingParameterException - missing cluSetId or contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
  - getCluSetTreeView
```
CluSetTreeViewInfo getCluSetTreeView(String cluSetId,
                                   ContextInfo contextInfo)
                                     throws DoesNotExistException,
                                            InvalidParameterException,
                                            MissingParameterException,
                                            OperationFailedException,
                                            PermissionDeniedException
```
    Retrieve information on a CLU set and its sub clu set fully expanded.
    
    Parameters:
    cluSetId - Identifier of the CLU set
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    The retrieved CLU set tree view information
    
    Throws:
    
    DoesNotExistException - cluSetId not found
    
    InvalidParameterException - invalid contextInfo
    
    MissingParameterException - missing cluSetId or contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
  - getCluSetsByIds
```
List<CluSetInfo> getCluSetsByIds(List<String> cluSetIds,
                               ContextInfo contextInfo)
                                 throws DoesNotExistException,
                                        InvalidParameterException,
                                        MissingParameterException,
                                        OperationFailedException,
                                        PermissionDeniedException
```
    Retrieve information on CLU sets from a list of cluSet Ids.
    
    Parameters:
    cluSetIds - List of identifiers of CLU sets
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    The retrieved list of CLU set information
    
    Throws:
    
    DoesNotExistException - One or more cluSets not found
    
    InvalidParameterException - invalid contextInfo
    
    MissingParameterException - missing cluSetIds or contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
  - getCluSetIdsFromCluSet
```
List<String> getCluSetIdsFromCluSet(String cluSetId,
                                  ContextInfo contextInfo)
                                    throws DoesNotExistException,
                                           InvalidParameterException,
                                           MissingParameterException,
                                           OperationFailedException,
                                           PermissionDeniedException
```
    Retrieve the list of CLU Set Ids within a CLU Set
    
    Parameters:
    cluSetId - Identifier of the CLU set
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    The retrieved list of CLU Set Ids within the specified CLU set
    
    Throws:
    
    DoesNotExistException - cluSet not found
    
    InvalidParameterException - invalid contextInfo
    
    MissingParameterException - missing cluSetId or contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
  - isCluSetDynamic
```
Boolean isCluSetDynamic(String cluSetId,
                      ContextInfo contextInfo)
                        throws DoesNotExistException,
                               InvalidParameterException,
                               MissingParameterException,
                               OperationFailedException,
                               PermissionDeniedException
```
    Check if the given CluSet is dynamic
    
    Parameters:
    cluSetId - Identifier of the CLU set
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    The retrieved list of CLU Set Ids within the specified CLU set
    
    Throws:
    
    DoesNotExistException - cluSetId not found
    
    InvalidParameterException - invalid contextInfo
    
    MissingParameterException - missing cluSetId or contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
  - getClusFromCluSet
```
List<CluInfo> getClusFromCluSet(String cluSetId,
                              ContextInfo contextInfo)
                                throws DoesNotExistException,
                                       InvalidParameterException,
                                       MissingParameterException,
                                       OperationFailedException,
                                       PermissionDeniedException
```
    Retrieves the list of CLUs in a CLU set. This only retrieves the direct members.
    
    Parameters:
    cluSetId - Identifier of the CLU set
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    The retrieved list of information on the CLUs within the CLU set (flattened and de-duped)
    
    Throws:
    
    DoesNotExistException - cluSetId not found
    
    InvalidParameterException - invalid contextInfo
    
    MissingParameterException - missing cluSetId or contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
  - getCluIdsFromCluSet
```
List<String> getCluIdsFromCluSet(String cluSetId,
                               ContextInfo contextInfo)
                                 throws DoesNotExistException,
                                        InvalidParameterException,
                                        MissingParameterException,
                                        OperationFailedException,
                                        PermissionDeniedException
```
    Retrieves the list of CLU Identifiers within a CLU Set. This only retrieves the direct members.
    
    Parameters:
    cluSetId - Identifier of the CLU set
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    The retrieved list of CLU Ids within the specified CLU set (flattened and de-duped)
    
    Throws:
    
    DoesNotExistException - cluSetId not found
    
    InvalidParameterException - invalid contextInfo
    
    MissingParameterException - missing cluSetId or contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
  - getAllClusInCluSet
```
List<CluInfo> getAllClusInCluSet(String cluSetId,
                               ContextInfo contextInfo)
                                 throws DoesNotExistException,
                                        InvalidParameterException,
                                        MissingParameterException,
                                        OperationFailedException,
                                        PermissionDeniedException
```
    Retrieves the full list of CLUs in this CLU set or any cluset that is included within that.
    
    Parameters:
    cluSetId - Identifier of the CLU set
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    The retrieved list of information on the CLUs
    
    Throws:
    
    DoesNotExistException - cluSet not found
    
    InvalidParameterException - invalid contextInfo
    
    MissingParameterException - missing cluSetId or contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
  - getAllCluIdsInCluSet
```
List<String> getAllCluIdsInCluSet(String cluSetId,
                                ContextInfo contextInfo)
                                  throws DoesNotExistException,
                                         InvalidParameterException,
                                         MissingParameterException,
                                         OperationFailedException,
                                         PermissionDeniedException
```
    Retrieves the list of CLU Identifiers within a CLU Set or any cluset that is included within that.
    
    Parameters:
    cluSetId - Identifier of the CLU set
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    The retrieved list of CLU Ids within the specified CLU set
    
    Throws:
    
    DoesNotExistException - cluSetId not found
    
    InvalidParameterException - invalid contextInfo
    
    MissingParameterException - missing cluSetId or contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
  - isCluInCluSet
```
Boolean isCluInCluSet(String cluId,
                    String cluSetId,
                    ContextInfo contextInfo)
                      throws DoesNotExistException,
                             InvalidParameterException,
                             MissingParameterException,
                             OperationFailedException,
                             PermissionDeniedException
```
    Checks if a CLU is a member of a CLU set or any contained CLU set
    
    Parameters:
    cluId - Identifier of the CLU to check
    cluSetId - Identifier of the CLU set
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    True if the CLU is a member of the CLU Set
    
    Throws:
    
    DoesNotExistException - cluId, cluSetId not found
    
    InvalidParameterException - invalid contextInfo
    
    MissingParameterException - missing cluId, cluSetId or contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
  - validateClu
```
List<ValidationResultInfo> validateClu(String validationTypeKey,
                                     CluInfo cluInfo,
                                     ContextInfo contextInfo)
                                       throws DoesNotExistException,
                                              InvalidParameterException,
                                              MissingParameterException,
                                              OperationFailedException,
                                              PermissionDeniedException
```
    Validates a CLU. Depending on the value of validationType, this validation could be limited to tests on just the current object and its directly contained sub-objects or expanded to perform all tests related to this object. If an identifier is present for the CLU (and/or one of its contained sub-objects) and a record is found for that identifier, the validation checks if the CLU can be shifted to the new values. If an identifier is not present or a record cannot be found for the identifier, it is assumed that the record does not exist and as such, the checks performed will be much shallower, typically mimicking those performed by setting the validationType to the current object.
    
    Parameters:
    validationTypeKey - identifier of the extent of validation
    cluInfo - CLU information to be tested.
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    results from performing the validation
    
    Throws:
    
    DoesNotExistException - validationTypeKey not found
    
    InvalidParameterException - invalid cluInfo or contextInfo
    
    MissingParameterException - missing validationTypeKey, cluInfo or contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
  - createClu
```
CluInfo createClu(String luTypeKey,
                CluInfo cluInfo,
                ContextInfo contextInfo)
                  throws DataValidationErrorException,
                         DoesNotExistException,
                         InvalidParameterException,
                         MissingParameterException,
                         OperationFailedException,
                         PermissionDeniedException,
                         ReadOnlyException
```
    Creates a new CLU
    
    Parameters:
    luTypeKey - identifier of the LU Type for the CLU being created
    cluInfo - information about the CLU being created
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    the created CLU information
    
    Throws:
    
    DataValidationErrorException - supplied data is invalid
    
    DoesNotExistException - luTypeKey not found
    
    InvalidParameterException - invalid cluInfo or contextInfo
    
    MissingParameterException - missing luTypeKey, cluInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
    
    ReadOnlyException - an attempt at supplying information designated as read only
  - updateClu
```
CluInfo updateClu(String cluId,
                CluInfo cluInfo,
                ContextInfo contextInfo)
                  throws DataValidationErrorException,
                         DoesNotExistException,
                         InvalidParameterException,
                         MissingParameterException,
                         OperationFailedException,
                         PermissionDeniedException,
                         ReadOnlyException,
                         VersionMismatchException
```
    Updates an existing CLU
    
    Parameters:
    cluId - identifier for the CLU to be updated
    cluInfo - updated information about the CLU
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    the updated CLU information
    
    Throws:
    
    DataValidationErrorException - supplied data is invalid
    
    DoesNotExistException - cluId not found
    
    InvalidParameterException - invalid cluInfo or contextInfo
    
    MissingParameterException - missing cluId, cluInfo or contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
    
    ReadOnlyException - an attempt at supplying information designated as read only
    
    VersionMismatchException - an optimistic locking failure or the action was attempted on an out of date version
  - deleteClu
```
StatusInfo deleteClu(String cluId,
                   ContextInfo contextInfo)
                     throws DependentObjectsExistException,
                            DoesNotExistException,
                            InvalidParameterException,
                            MissingParameterException,
                            OperationFailedException,
                            PermissionDeniedException
```
    Deletes an existing CLU
    
    Parameters:
    cluId - identifier for the CLU to be deleted
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    status of the operation
    
    Throws:
    
    DependentObjectsExistException - delete would leave orphaned objects or violate integrity constraints
    
    DoesNotExistException - cluId not found
    
    InvalidParameterException - invalid contextInfo
    
    MissingParameterException - missing cluId or contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
  - createNewCluVersion
```
CluInfo createNewCluVersion(String cluId,
                          String versionComment,
                          ContextInfo contextInfo)
                            throws DataValidationErrorException,
                                   DoesNotExistException,
                                   InvalidParameterException,
                                   MissingParameterException,
                                   OperationFailedException,
                                   PermissionDeniedException,
                                   ReadOnlyException
```
    Creates a new CLU version based on the current clu
    
    Parameters:
    cluId - identifier for the CLU to be versioned
    versionComment - comment for the current version
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    the new versioned CLU information
    
    Throws:
    
    DataValidationErrorException - supplied data is invalid
    
    DoesNotExistException - cluId not found
    
    InvalidParameterException - invalid contextInfo
    
    MissingParameterException - missing cluId, versionComment or contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
    
    ReadOnlyException - an attempt at supplying information designated as read only
  - setCurrentCluVersion
```
StatusInfo setCurrentCluVersion(String cluVersionId,
                              Date currentVersionStart,
                              ContextInfo contextInfo)
                                throws DataValidationErrorException,
                                       DoesNotExistException,
                                       InvalidParameterException,
                                       MissingParameterException,
                                       IllegalVersionSequencingException,
                                       OperationFailedException,
                                       PermissionDeniedException
```
    Sets a specific version of the Clu as current. The sequence number must be greater than the existing current Clu version. This will truncate the current version's end date to the currentVersionStart param. If a Clu exists which is set to become current in the future, that clu's currentVersionStart and CurrentVersionEnd will be nullified. The currentVersionStart must be in the future to prevent changing historic data.
    
    Parameters:
    cluVersionId - Version Specific Id of the Clu
    currentVersionStart - Date when this clu becomes current. Must be in the future and be after the most current clu's start date.
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    status of the operation
    
    Throws:
    
    DataValidationErrorException - supplied data is invalid
    
    DoesNotExistException - cluVersionId not found
    
    InvalidParameterException - invalid contextInfo
    
    MissingParameterException - missing cluVersionId, previousState, newState
    
    IllegalVersionSequencingException - a Clu with higher sequence number from the one provided is marked current
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
  - updateCluState
```
CluInfo updateCluState(String cluId,
                     String luState,
                     ContextInfo contextInfo)
                       throws DataValidationErrorException,
                              DoesNotExistException,
                              InvalidParameterException,
                              MissingParameterException,
                              OperationFailedException,
                              PermissionDeniedException,
                              ReadOnlyException,
                              VersionMismatchException
```
    Updates the state of the specified CLU
    
    Parameters:
    cluId - identifier for the CLU to be updated
    luState - new state for the CLU. Value is expected to be constrained to those in the luState enumeration.
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    the updated CLU information
    
    Throws:
    
    DataValidationErrorException - supplied data is invalid
    
    DoesNotExistException - cluId not found
    
    InvalidParameterException - invalid contextInfo
    
    MissingParameterException - missing cluId, luState or contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
    
    ReadOnlyException - an attempt at supplying information designated as read only
    
    VersionMismatchException - an optimistic locking failure or the action was attempted on an out of date version
  - validateCluCluRelation
```
List<ValidationResultInfo> validateCluCluRelation(String validationTypeKey,
                                                String cluId,
                                                String relatedCluId,
                                                String cluCluRelationTypeKey,
                                                CluCluRelationInfo cluCluRelationInfo,
                                                ContextInfo contextInfo)
                                                  throws DoesNotExistException,
                                                         InvalidParameterException,
                                                         MissingParameterException,
                                                         OperationFailedException,
                                                         PermissionDeniedException
```
    Validates a cluCluRelation. Depending on the value of validationType, this validation could be limited to tests on just the current object and its directly contained sub-objects or expanded to perform all tests related to this object. If an identifier is present for the cluCluRelation (and/or one of its contained sub-objects) and a record is found for that identifier, the validation checks if the relationship can be shifted to the new values. If an identifier is not present or a record cannot be found for the identifier, it is assumed that the record does not exist and as such, the checks performed will be much shallower, typically mimicking those performed by setting the validationType to the current object.
    
    Parameters:
    validationTypeKey - identifier of the extent of validation
    cluId - identifier of the first CLU in the relationship - The From or Parent of the relation
    relatedCluId - identifier of the second CLU in the relationship to be related to - the To or Child of the Relation
    cluCluRelationTypeKey - the CLU to CLU relationship type of the relationship
    cluCluRelationInfo - cluCluRelation information to be tested.
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    results from performing the validation
    
    Throws:
    
    DoesNotExistException - validationTypeKey, cluId, relatedCluId or cluCluRelationTypeKey not found
    
    InvalidParameterException - invalid cluCluRelationInfo or contextInfo
    
    MissingParameterException - missing validationTypeKey, cluId, relatedCluId, cluCluRelationTypeKey or cluCluRelationInfo or contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
  - createCluCluRelation
```
CluCluRelationInfo createCluCluRelation(String cluId,
                                      String relatedCluId,
                                      String cluCluRelationTypeKey,
                                      CluCluRelationInfo cluCluRelationInfo,
                                      ContextInfo contextInfo)
                                        throws CircularRelationshipException,
                                               DataValidationErrorException,
                                               DoesNotExistException,
                                               InvalidParameterException,
                                               MissingParameterException,
                                               OperationFailedException,
                                               PermissionDeniedException,
                                               ReadOnlyException
```
    Create a directional relationship between two CLUs
    
    Parameters:
    cluId - identifier of the first CLU in the relationship - The From or Parent of the relation
    relatedCluId - identifier of the second CLU in the relationship to be related to - the To or Child of the Relation
    cluCluRelationTypeKey - the LU to LU relationship type of the relationship
    cluCluRelationInfo - information about the relationship between the two CLUs
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    the created CLU to CLU relation information
    
    Throws:
    
    CircularRelationshipException - cluId equals relatedCluId
    
    DataValidationErrorException - One or more values invalid for this operation
    
    DoesNotExistException - cluId, relatedCluId, cluCluRelationTypeKey not found
    
    InvalidParameterException - invalid cluCluRelationInfo or contextInfo
    
    MissingParameterException - missing cluId, relatedCluId, cluCluRelationTypeKey, cluCluRelationInfo or contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
    
    ReadOnlyException - an attempt at supplying information designated as read only
  - updateCluCluRelation
```
CluCluRelationInfo updateCluCluRelation(String cluCluRelationId,
                                      CluCluRelationInfo cluCluRelationInfo,
                                      ContextInfo contextInfo)
                                        throws DataValidationErrorException,
                                               DoesNotExistException,
                                               InvalidParameterException,
                                               MissingParameterException,
                                               OperationFailedException,
                                               PermissionDeniedException,
                                               ReadOnlyException,
                                               VersionMismatchException
```
    Updates a relationship between two CLUs
    
    Parameters:
    cluCluRelationId - identifier of the CLU to CLU relation to be updated
    cluCluRelationInfo - changed information about the CLU to CLU relationship
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    the updated CLU to CLU relation information
    
    Throws:
    
    DataValidationErrorException - One or more values invalid for this operation
    
    DoesNotExistException - cluCluRelation not found
    
    InvalidParameterException - invalid cluCluRelationInfo or contextInfo
    
    MissingParameterException - missing cluCluRelationId, cluCluRelationInfo or contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
    
    ReadOnlyException - an attempt at supplying information designated as read only
    
    VersionMismatchException - an optimistic locking failure or the action was attempted on an out of date version
  - deleteCluCluRelation
```
StatusInfo deleteCluCluRelation(String cluCluRelationId,
                              ContextInfo contextInfo)
                                throws DoesNotExistException,
                                       InvalidParameterException,
                                       MissingParameterException,
                                       OperationFailedException,
                                       PermissionDeniedException
```
    Deletes a relationship between two CLUs
    
    Parameters:
    cluCluRelationId - identifier of CLU to CLU relationship to delete
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    status of the operation (success or failure)
    
    Throws:
    
    DoesNotExistException - cluCluRelationId not found
    
    InvalidParameterException - invalid contextInfo
    
    MissingParameterException - missing cluCluRelationId or contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
  - validateCluPublication
```
List<ValidationResultInfo> validateCluPublication(String validationTypeKey,
                                                String cluId,
                                                String luPublicationTypeKey,
                                                CluPublicationInfo cluPublicationInfo,
                                                ContextInfo contextInfo)
                                                  throws DoesNotExistException,
                                                         InvalidParameterException,
                                                         MissingParameterException,
                                                         OperationFailedException,
                                                         PermissionDeniedException
```
    Validates information about publication for a clu. Depending on the value of validationTypeKey, this validation could be limited to tests on just the current object and its directly contained sub-objects or expanded to perform all tests related to this object. If an identifier is present for the clu publication object (and/or one of its contained sub-objects) and a record is found for that identifier, the validation checks if the clu publication object can be shifted to the new values. If an identifier is not present or a record cannot be found for the identifier, it is assumed that the record does not exist and as such, the checks performed will be much shallower, typically mimicking those performed by setting the validationTypeKey to the current object.
    
    Parameters:
    validationTypeKey - identifier of the extent of validation
    cluId - identifier of a clu
    luPublicationTypeKey - type of lu publication
    cluPublicationInfo - CLU publication information to be tested.
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    results from performing the validation
    
    Throws:
    
    DoesNotExistException - validationTypeKey, cluId or luPublicationTypeKey not found
    
    InvalidParameterException - invalid cluPublicationInfo or contextInfo
    
    MissingParameterException - missing validationTypeKey, cluId, luPublicationTypeKey, cluPublicationInfo or contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
  - createCluPublication
```
CluPublicationInfo createCluPublication(String cluId,
                                      String luPublicationTypeKey,
                                      CluPublicationInfo cluPublicationInfo,
                                      ContextInfo contextInfo)
                                        throws DataValidationErrorException,
                                               InvalidParameterException,
                                               MissingParameterException,
                                               OperationFailedException,
                                               PermissionDeniedException,
                                               ReadOnlyException
```
    Create a clu publication object, which contains information about publication for a clu.
    
    Parameters:
    cluId - identifier of a clu
    luPublicationTypeKey - type of lu publication
    cluPublicationInfo - information about publication for a clu
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    information about the created clu publication object
    
    Throws:
    
    DataValidationErrorException - supplied data is invalid
    
    DoesNotExistException - cluId or luPublicationTypeKey not found
    
    InvalidParameterException - invalid cluPublicationInfo or contextInfo
    
    MissingParameterException - missing cluId, luPublicationTypeKey, cluPublicationInfo or contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
    
    ReadOnlyException - an attempt at supplying information designated as read only
  - updateCluPublication
```
CluPublicationInfo updateCluPublication(String cluPublicationId,
                                      CluPublicationInfo cluPublicationInfo,
                                      ContextInfo contextInfo)
                                        throws DataValidationErrorException,
                                               DoesNotExistException,
                                               InvalidParameterException,
                                               MissingParameterException,
                                               OperationFailedException,
                                               PermissionDeniedException,
                                               ReadOnlyException,
                                               VersionMismatchException
```
    Updates an existing clu publication object
    
    Parameters:
    cluPublicationId - identifier for the clu publication object to be updated
    cluPublicationInfo - updated information about the clu publication object
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    the updated clu publication information
    
    Throws:
    
    DataValidationErrorException - supplied data is invalid
    
    DoesNotExistException - cluPublicationId not found
    
    InvalidParameterException - invalid cluPublicationInfo or contextInfo
    
    MissingParameterException - missing cluPublicationId, cluPublicationInfo or contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
    
    ReadOnlyException - an attempt at supplying information designated as read only
    
    VersionMismatchException - The action was attempted on an out of date version.
  - deleteCluPublication
```
StatusInfo deleteCluPublication(String cluPublicationId,
                              ContextInfo contextInfo)
                                throws DoesNotExistException,
                                       InvalidParameterException,
                                       MissingParameterException,
                                       DependentObjectsExistException,
                                       OperationFailedException,
                                       PermissionDeniedException
```
    Deletes an existing clu publication object
    
    Parameters:
    cluPublicationId - identifier for the clu publication object to be deleted
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    status of the operation
    
    Throws:
    
    DependentObjectsExistException - delete would leave orphaned objects or violate integrity constraints
    
    DoesNotExistException - cluPublicationId not found
    
    InvalidParameterException - invalid contextInfo
    
    MissingParameterException - missing cluPublicationId or contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
  - validateCluResult
```
List<ValidationResultInfo> validateCluResult(String validationTypeKey,
                                           String cluId,
                                           String cluResultTypeKey,
                                           CluResultInfo cluResultInfo,
                                           ContextInfo contextInfo)
                                             throws DoesNotExistException,
                                                    InvalidParameterException,
                                                    MissingParameterException,
                                                    OperationFailedException,
                                                    PermissionDeniedException
```
    Validates information about results for a clu. Depending on the value of validationTypeKey, this validation could be limited to tests on just the current object and its directly contained sub-objects or expanded to perform all tests related to this object. If an identifier is present for the clu result object (and/or one of its contained sub-objects) and a record is found for that identifier, the validation checks if the clu result object can be shifted to the new values. If an identifier is not present or a record cannot be found for the identifier, it is assumed that the record does not exist and as such, the checks performed will be much shallower, typically mimicking those performed by setting the validationTypeKey to the current object.
    
    Parameters:
    validationTypeKey - identifier of the extent of validation
    cluId - identifier of a clu
    cluResultTypeKey - type of clu result
    cluResultInfo - CLU result information to be tested.
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    results from performing the validation
    
    Throws:
    
    DoesNotExistException - validationTypeKey, cluId or cluResultTypeKey not found
    
    InvalidParameterException - invalid cluResultInfo or contextInfo
    
    MissingParameterException - missing validationTypeKey, cluId, cluResultTypeKey, cluResultInfo or contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
  - createCluResult
```
CluResultInfo createCluResult(String cluId,
                            String cluResultTypeKey,
                            CluResultInfo cluResultInfo,
                            ContextInfo contextInfo)
                              throws DataValidationErrorException,
                                     DoesNotExistException,
                                     InvalidParameterException,
                                     MissingParameterException,
                                     OperationFailedException,
                                     PermissionDeniedException,
                                     ReadOnlyException
```
    Create a clu result object, which contains information about potential results for a clu.
    
    Parameters:
    cluId - identifier of a clu
    cluResultTypeKey - type of clu result
    cluResultInfo - information about potential results for a clu
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    information about the created clu result
    
    Throws:
    
    DataValidationErrorException - supplied data is invalid
    
    DoesNotExistException - cluId or resultUsageTypeKey not found
    
    InvalidParameterException - invalid cluResultInfo or contextInfo
    
    MissingParameterException - missing cluId, cluResultTypeKey, cluResultInfo or contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
    
    ReadOnlyException - an attempt at supplying information designated as read only
  - updateCluResult
```
CluResultInfo updateCluResult(String cluResultId,
                            CluResultInfo cluResultInfo,
                            ContextInfo contextInfo)
                              throws DataValidationErrorException,
                                     DoesNotExistException,
                                     InvalidParameterException,
                                     MissingParameterException,
                                     OperationFailedException,
                                     PermissionDeniedException,
                                     ReadOnlyException,
                                     VersionMismatchException
```
    Updates an existing clu result
    
    Parameters:
    cluResultId - identifier for the clu result to be updated
    cluResultInfo - updated information about the clu result
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    the updated clu result information
    
    Throws:
    
    DataValidationErrorException - One or more values invalid for this operation
    
    DoesNotExistException - cluResultId not found
    
    InvalidParameterException - invalid contextInfo
    
    MissingParameterException - missing cluResultId, cluResultInfo or contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
    
    ReadOnlyException - an attempt at supplying information designated as read only
    
    VersionMismatchException - an optimistic locking failure or the action was attempted on an out of date version
  - deleteCluResult
```
StatusInfo deleteCluResult(String cluResultId,
                         ContextInfo contextInfo)
                           throws DoesNotExistException,
                                  InvalidParameterException,
                                  MissingParameterException,
                                  DependentObjectsExistException,
                                  OperationFailedException,
                                  PermissionDeniedException
```
    Deletes an existing clu result
    
    Parameters:
    cluResultId - identifier for the clu result to be deleted
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    status of the operation
    
    Throws:
    
    DoesNotExistException - cluResultId not found
    
    InvalidParameterException - invalid contextInfo
    
    MissingParameterException - missing cluResultId or contextInfo
    
    DependentObjectsExistException - delete would leave orphaned objects or violate integrity constraints
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
  - validateCluLoRelation
```
List<ValidationResultInfo> validateCluLoRelation(String validationTypeKey,
                                               String cluId,
                                               String loId,
                                               String cluLoRelationTypeKey,
                                               CluLoRelationInfo cluLoRelationInfo,
                                               ContextInfo contextInfo)
                                                 throws DoesNotExistException,
                                                        InvalidParameterException,
                                                        MissingParameterException,
                                                        OperationFailedException,
                                                        PermissionDeniedException
```
    Validates a cluLoRelation. Depending on the value of validationTypeKey, this validation could be limited to tests on just the current object and its directly contained sub-objects or expanded to perform all tests related to this object. If an identifier is present for the cluLoRelation (and/or one of its contained sub-objects) and a record is found for that identifier, the validation checks if the relationship can be shifted to the new values. If an identifier is not present or a record cannot be found for the identifier, it is assumed that the record does not exist and as such, the checks performed will be much shallower, typically mimicking those performed by setting the validationTypeKey to the current object.
    
    Parameters:
    validationTypeKey - identifier of the extent of validation
    cluId - CLU identifier
    loId - learning objective identifier
    cluLoRelationTypeKey - type of clu learning objective relationship
    cluLoRelationInfo - cluLoRelation information to be tested.
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    results from performing the validation
    
    Throws:
    
    DoesNotExistException - validationTypeKey, cluId, loId or cluLoRelationTypeKey not found
    
    InvalidParameterException - invalid cluLoRelationInfo or contextInfo
    
    MissingParameterException - missing validationTypeKey, cluId, loId, cluLoRelationTypeKey, cluLoRelationInfo or contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
  - createCluLoRelation
```
CluLoRelationInfo createCluLoRelation(String cluId,
                                    String loId,
                                    String cluLoRelationTypeKey,
                                    CluLoRelationInfo cluLoRelationInfo,
                                    ContextInfo contextInfo)
                                      throws DataValidationErrorException,
                                             DoesNotExistException,
                                             InvalidParameterException,
                                             MissingParameterException,
                                             OperationFailedException,
                                             PermissionDeniedException,
                                             ReadOnlyException
```
    Creates a relationship between a learning objective and a CLU.
    
    Parameters:
    cluId - CLU identifier
    loId - learning objective identifier
    cluLoRelationTypeKey - type of clu learning objective relationship
    cluLoRelationInfo - clu learning objective relationship information
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    the newly created clu learning objective relationship
    
    Throws:
    
    DataValidationErrorException - data validation error
    
    DoesNotExistException - cluId, loId, cluLoRelationTypeKey not found
    
    InvalidParameterException - invalid cluLoRelationInfo or contextInfo
    
    MissingParameterException - missing cluId, loId, cluLoRelationTypeKey, cluLoRelationInfo or contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
    
    ReadOnlyException - an attempt at supplying information designated as read only
  - updateCluLoRelation
```
CluLoRelationInfo updateCluLoRelation(String cluLoRelationId,
                                    CluLoRelationInfo cluLoRelationInfo,
                                    ContextInfo contextInfo)
                                      throws DataValidationErrorException,
                                             DoesNotExistException,
                                             InvalidParameterException,
                                             MissingParameterException,
                                             OperationFailedException,
                                             PermissionDeniedException,
                                             ReadOnlyException,
                                             VersionMismatchException
```
    Updates a relationship between a clu and learning objective
    
    Parameters:
    cluLoRelationId - identifier of the clu learning objective relationship to be updated
    cluLoRelationInfo - information about the clu learning objective relationship to be updated
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    the updated clu learning objective relationship information
    
    Throws:
    
    DataValidationErrorException - data validation error
    
    DoesNotExistException - cluLoRelationId not found
    
    InvalidParameterException - invalid cluLoRelationInfo or contextInfo
    
    MissingParameterException - missing cluLoRelationId, cluLoRelationInfo or contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
    
    ReadOnlyException - an attempt at supplying information designated as read only
    
    VersionMismatchException - The action was attempted on an out of date version.
  - deleteCluLoRelation
```
StatusInfo deleteCluLoRelation(String cluLoRelationId,
                             ContextInfo contextInfo)
                               throws DoesNotExistException,
                                      InvalidParameterException,
                                      MissingParameterException,
                                      OperationFailedException,
                                      PermissionDeniedException
```
    Removes a relationship between a learning objective and a Clu.
    
    Parameters:
    cluLoRelationId - CLU learning objective Relationship identifier
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    Status of the delete operation
    
    Throws:
    
    DoesNotExistException - cluLoRelationId not found
    
    InvalidParameterException - invalid contextInfo
    
    MissingParameterException - missing cluLoRelationId
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
  - addCluResourceRequirement
```
StatusInfo addCluResourceRequirement(String resourceTypeKey,
                                   String cluId,
                                   ContextInfo contextInfo)
                                     throws AlreadyExistsException,
                                            DoesNotExistException,
                                            InvalidParameterException,
                                            MissingParameterException,
                                            OperationFailedException,
                                            PermissionDeniedException
```
    Add a Resource requirement to a CLU
    
    Parameters:
    resourceTypeKey - identifier of the resource requirement type to be added to the CLU
    cluId - identifier of the CLU
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    status of the operation (success or failure)
    
    Throws:
    
    AlreadyExistsException - if the resource type has already been added to the clu
    
    DoesNotExistException - resourceTypeKey or cluId not found
    
    InvalidParameterException - invalid resourceTypeKey or cluId
    
    MissingParameterException - missing resourceTypeKey, cluId or contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
  - removeCluResourceRequirement
```
StatusInfo removeCluResourceRequirement(String resourceTypeKey,
                                      String cluId,
                                      ContextInfo contextInfo)
                                        throws DoesNotExistException,
                                               InvalidParameterException,
                                               MissingParameterException,
                                               OperationFailedException,
                                               PermissionDeniedException
```
    Remove a Resource requirement from a CLU
    
    Parameters:
    resourceTypeKey - identifier of the resource type to be removed from the CLU
    cluId - identifier of the CLU
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    status of the operation (success or failure)
    
    Throws:
    
    DoesNotExistException - resourceTypeKey or cluId not found
    
    InvalidParameterException - invalid contextInfo
    
    MissingParameterException - missing resourceTypeKey, cluId or contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
  - validateCluSet
```
List<ValidationResultInfo> validateCluSet(String validationTypeKey,
                                        String cluSetTypeKey,
                                        CluSetInfo cluSetInfo,
                                        ContextInfo contextInfo)
                                          throws DoesNotExistException,
                                                 InvalidParameterException,
                                                 MissingParameterException,
                                                 OperationFailedException,
                                                 PermissionDeniedException
```
    Validates information about a clu set. Depending on the value of validationTypeKey, this validation could be limited to tests on just the current object and its directly contained sub-objects or expanded to perform all tests related to this object. If an identifier is present for the clu set (and/or one of its contained sub-objects) and a record is found for that identifier, the validation checks if the clu set can be shifted to the new values. If an identifier is not present or a record cannot be found for the identifier, it is assumed that the record does not exist and as such, the checks performed will be much shallower, typically mimicking those performed by setting the validationType to the current object.
    
    Parameters:
    validationTypeKey - identifier of the extent of validation
    cluSetTypeKey - type of the CLU set to be created
    cluSetInfo - CLU set information to be tested.
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    results from performing the validation
    
    Throws:
    
    DoesNotExistException - validationTypeKey or cluSetTypeKey not found
    
    InvalidParameterException - invalid cluSetInfo or contextInfo
    
    MissingParameterException - missing validationTypeKey, cluSetTypeKey, cluSetInfo or contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
  - createCluSet
```
CluSetInfo createCluSet(String cluSetTypeKey,
                      CluSetInfo cluSetInfo,
                      ContextInfo contextInfo)
                        throws DataValidationErrorException,
                               DoesNotExistException,
                               InvalidParameterException,
                               MissingParameterException,
                               OperationFailedException,
                               PermissionDeniedException,
                               ReadOnlyException,
                               UnsupportedActionException
```
    Creates a CLU set.
    
    Parameters:
    cluSetTypeKey - type of the CLU set to be created
    cluSetInfo - information required to create a CLU set
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    the created CLU set information
    
    Throws:
    
    DataValidationErrorException - data validation error
    
    DoesNotExistException - cluSetTypeKey not found
    
    InvalidParameterException - invalid cluSetInfo or contextInfo
    
    MissingParameterException - missing cluSetTypeKey, cluSetInfo or contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
    
    ReadOnlyException - an attempt at supplying information designated as read only
    
    UnsupportedActionException - CLU set need to be static or dynamic but not both
  - updateCluSet
```
CluSetInfo updateCluSet(String cluSetId,
                      CluSetInfo cluSetInfo,
                      ContextInfo contextInfo)
                        throws CircularRelationshipException,
                               DataValidationErrorException,
                               DoesNotExistException,
                               InvalidParameterException,
                               MissingParameterException,
                               OperationFailedException,
                               PermissionDeniedException,
                               ReadOnlyException,
                               UnsupportedActionException,
                               VersionMismatchException
```
    Update the information for a CLU set
    
    Parameters:
    cluSetId - identifier of the CLU set to be updated
    cluSetInfo - updated information about the CLU set
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    the updated CLU set information
    
    Throws:
    
    CircularRelationshipException - added CluSetId cannot be added to the cluSetInfo
    
    DataValidationErrorException - data validation error
    
    DoesNotExistException - cluSetId not found
    
    InvalidParameterException - invalid cluSetInfo or contextInfo
    
    MissingParameterException - missing cluSetId, cluSetInfo or contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
    
    ReadOnlyException - an attempt at supplying information designated as read only
    
    UnsupportedActionException - CLU set need to be static or dynamic but not both
    
    VersionMismatchException - an optimistic locking failure or the action was attempted on an out of date version
  - deleteCluSet
```
StatusInfo deleteCluSet(String cluSetId,
                      ContextInfo contextInfo)
                        throws DoesNotExistException,
                               InvalidParameterException,
                               MissingParameterException,
                               OperationFailedException,
                               PermissionDeniedException
```
    Delete a CLU set
    
    Parameters:
    cluSetId - identifier of the CLU set to be deleted
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    status of the operation (success or failure)
    
    Throws:
    
    DoesNotExistException - cluSetId not found
    
    InvalidParameterException - invalid contextInfo
    
    MissingParameterException - missing cluSetId or contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
  - addCluSetToCluSet
```
StatusInfo addCluSetToCluSet(String cluSetId,
                           String addedCluSetId,
                           ContextInfo contextInfo)
                             throws CircularRelationshipException,
                                    DoesNotExistException,
                                    InvalidParameterException,
                                    MissingParameterException,
                                    OperationFailedException,
                                    PermissionDeniedException,
                                    UnsupportedActionException
```
    Adds one CLU set to another
    
    Parameters:
    cluSetId - identifier of the host CLU set
    addedCluSetId - identifier of the CLU set to be added
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    status of the operation (success or failure)
    
    Throws:
    
    CircularRelationshipException - addedCluSetId cannot be added to the CluSetId
    
    DoesNotExistException - cluSetId, addedCluSetId not found
    
    InvalidParameterException - invalid contextInfo
    
    MissingParameterException - missing cluSetId, addedCluSetId or contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
    
    UnsupportedActionException - CLU set is dynamically determined
  - addCluSetsToCluSet
```
StatusInfo addCluSetsToCluSet(String cluSetId,
                            List<String> addedCluSetIds,
                            ContextInfo contextInfo)
                              throws CircularRelationshipException,
                                     DoesNotExistException,
                                     InvalidParameterException,
                                     MissingParameterException,
                                     OperationFailedException,
                                     PermissionDeniedException,
                                     UnsupportedActionException
```
    Adds a list of CLU sets to another CluSet. If any individual one would fail, then an error is returned and none are added.
    
    Parameters:
    cluSetId - identifier of the host CLU set
    addedCluSetIds - list of identifiers of the CLU sets to be added
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    status of the operation (success or failure)
    
    Throws:
    
    CircularRelationshipException - addedCluSetIds cannot be added to the cluSetId
    
    DoesNotExistException - cluSetId, one or more of cluSetIds in addedCluSetIds not found
    
    InvalidParameterException - invalid contextInfo
    
    MissingParameterException - missing cluSetId, addedCluSetIds or contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
    
    UnsupportedActionException - CLU set is dynamically determined
  - removeCluSetFromCluSet
```
StatusInfo removeCluSetFromCluSet(String cluSetId,
                                String removedCluSetId,
                                ContextInfo contextInfo)
                                  throws DoesNotExistException,
                                         InvalidParameterException,
                                         MissingParameterException,
                                         OperationFailedException,
                                         PermissionDeniedException,
                                         UnsupportedActionException
```
    Removes one CLU set from another
    
    Parameters:
    cluSetId - identifier of the host CLU set
    removedCluSetId - identifier of the CLU set to be removed
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    status of the operation (success or failure)
    
    Throws:
    
    DoesNotExistException - cluSetId, removedCluSetId not found
    
    InvalidParameterException - invalid contextInfo
    
    MissingParameterException - missing cluSetId, removedCluSetId or contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
    
    UnsupportedActionException - CLU set is dynamically determined
  - addCluToCluSet
```
StatusInfo addCluToCluSet(String cluId,
                        String cluSetId,
                        ContextInfo contextInfo)
                          throws DoesNotExistException,
                                 InvalidParameterException,
                                 MissingParameterException,
                                 OperationFailedException,
                                 PermissionDeniedException,
                                 UnsupportedActionException
```
    Add a CLU to a CLU set
    
    Parameters:
    cluId - identifier of CLU to add to the CLU set
    cluSetId - identifier of the CLU set
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    status of the operation (success or failure)
    
    Throws:
    
    DoesNotExistException - cluId, cluSetId not found
    
    InvalidParameterException - invalid contextInfo
    
    MissingParameterException - missing cluId, cluSetId or contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
    
    UnsupportedActionException - CLU set is dynamically determined
  - addClusToCluSet
```
StatusInfo addClusToCluSet(List<String> cluSetIds,
                         String cluSetId,
                         ContextInfo contextInfo)
                           throws DoesNotExistException,
                                  InvalidParameterException,
                                  MissingParameterException,
                                  OperationFailedException,
                                  PermissionDeniedException,
                                  UnsupportedActionException
```
    Adds a list of CLUs to a CLU set. If any individual one would fail, then an error is returned and none are added.
    
    Parameters:
    cluSetIds - list of identifiers of CLUs to add to the CLU set
    cluSetId - identifier of the CLU set to be added
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    status of the operation (success or failure)
    
    Throws:
    
    DoesNotExistException - cluSetIds, cluSetId not found
    
    InvalidParameterException - invalid contextInfo
    
    MissingParameterException - missing cluSetIds, cluSetId or contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
    
    UnsupportedActionException - CLU set is dynamically determined
  - removeCluFromCluSet
```
StatusInfo removeCluFromCluSet(String cluId,
                             String cluSetId,
                             ContextInfo contextInfo)
                               throws DoesNotExistException,
                                      InvalidParameterException,
                                      MissingParameterException,
                                      OperationFailedException,
                                      PermissionDeniedException,
                                      UnsupportedActionException
```
    Remove a CLU from a CLU set
    
    Parameters:
    cluId - identifier of CLU to remove from the CLU set
    cluSetId - identifier of the CLU set
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    status of the operation (success or failure)
    
    Throws:
    
    DoesNotExistException - cluId, cluSetId not found
    
    InvalidParameterException - invalid contextInfo
    
    MissingParameterException - missing cluId, cluSetId or contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
    
    UnsupportedActionException - CLU set is dynamically determined
  - searchForClus
```
List<CluInfo> searchForClus(QueryByCriteria criteria,
                          ContextInfo contextInfo)
                            throws InvalidParameterException,
                                   MissingParameterException,
                                   OperationFailedException,
                                   PermissionDeniedException
```
    Search for Clus using free form search criteria.
    
    Parameters:
    criteria - the search criteria.
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    the list of matching Clus
    
    Throws:
    
    InvalidParameterException - criteria or contextInfo is null
    
    MissingParameterException - missing criteria or contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
  - searchForCluIds
```
List<String> searchForCluIds(QueryByCriteria criteria,
                           ContextInfo contextInfo)
                             throws InvalidParameterException,
                                    MissingParameterException,
                                    OperationFailedException,
                                    PermissionDeniedException
```
    Search for Clu Ids using free form search criteria
    
    Parameters:
    criteria - the search criteria.
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    the list of matching Clu Ids
    
    Throws:
    
    InvalidParameterException - criteria or contextInfo is null
    
    MissingParameterException - missing criteria or contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
  - searchForCluCluRelations
```
List<CluCluRelationInfo> searchForCluCluRelations(QueryByCriteria criteria,
                                                ContextInfo contextInfo)
                                                  throws InvalidParameterException,
                                                         MissingParameterException,
                                                         OperationFailedException,
                                                         PermissionDeniedException
```
    Search for CluCluRelations using free form search criteria
    
    Parameters:
    criteria - the search criteria.
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    the list of matching CluCluRelations
    
    Throws:
    
    InvalidParameterException - criteria or contextInfo is null
    
    MissingParameterException - missing criteria or contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
  - searchForCluCluRelationIds
```
List<String> searchForCluCluRelationIds(QueryByCriteria criteria,
                                      ContextInfo contextInfo)
                                        throws InvalidParameterException,
                                               MissingParameterException,
                                               OperationFailedException,
                                               PermissionDeniedException
```
    Search for CluCluRelation Ids using free form search criteria
    
    Parameters:
    criteria - the search criteria.
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    the list of matching CluCluRelation Ids
    
    Throws:
    
    InvalidParameterException - criteria or contextInfo is null
    
    MissingParameterException - missing criteria or contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
  - searchForCluLoRelations
```
List<CluLoRelationInfo> searchForCluLoRelations(QueryByCriteria criteria,
                                              ContextInfo contextInfo)
                                                throws InvalidParameterException,
                                                       MissingParameterException,
                                                       OperationFailedException,
                                                       PermissionDeniedException
```
    Search for CluLoRelations using free form search criteria.
    
    Parameters:
    criteria - the search criteria.
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    the list of matching CluLoRelations
    
    Throws:
    
    InvalidParameterException - criteria or contextInfo is null
    
    MissingParameterException - missing criteria or contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
  - searchForCluLoRelationIds
```
List<String> searchForCluLoRelationIds(QueryByCriteria criteria,
                                     ContextInfo contextInfo)
                                       throws InvalidParameterException,
                                              MissingParameterException,
                                              OperationFailedException,
                                              PermissionDeniedException
```
    Search for CluLoRelation Ids using free form search criteria
    
    Parameters:
    criteria - the search criteria.
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    the list of matching CluLoRelation Ids
    
    Throws:
    
    InvalidParameterException - criteria or contextInfo is null
    
    MissingParameterException - missing criteria or contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
  - searchForCluPublications
```
List<CluPublicationInfo> searchForCluPublications(QueryByCriteria criteria,
                                                ContextInfo contextInfo)
                                                  throws InvalidParameterException,
                                                         MissingParameterException,
                                                         OperationFailedException,
                                                         PermissionDeniedException
```
    Search for CluPublications using free form search criteria
    
    Parameters:
    criteria - the search criteria.
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    the list of matching CluPublications
    
    Throws:
    
    InvalidParameterException - criteria or contextInfo is null
    
    MissingParameterException - missing criteria or contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
  - searchForCluPublicationIds
```
List<String> searchForCluPublicationIds(QueryByCriteria criteria,
                                      ContextInfo contextInfo)
                                        throws InvalidParameterException,
                                               MissingParameterException,
                                               OperationFailedException,
                                               PermissionDeniedException
```
    Search for CluPublication Ids using free form search criteria
    
    Parameters:
    criteria - the search criteria.
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    the list of matching CluPublication Ids
    
    Throws:
    
    InvalidParameterException - criteria or contextInfo is null
    
    MissingParameterException - missing criteria or contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
  - searchForCluResults
```
List<CluResultInfo> searchForCluResults(QueryByCriteria criteria,
                                      ContextInfo contextInfo)
                                        throws InvalidParameterException,
                                               MissingParameterException,
                                               OperationFailedException,
                                               PermissionDeniedException
```
    Search for CluResults using free form search criteria
    
    Parameters:
    criteria - the search criteria.
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    the list of matching CluResults
    
    Throws:
    
    InvalidParameterException - criteria or contextInfo is null
    
    MissingParameterException - missing criteria or contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure
  - searchForCluResultIds
```
List<String> searchForCluResultIds(QueryByCriteria criteria,
                                 ContextInfo contextInfo)
                                   throws InvalidParameterException,
                                          MissingParameterException,
                                          OperationFailedException,
                                          PermissionDeniedException
```
    Search for CluResult Ids using free form search criteria
    
    Parameters:
    criteria - the search criteria.
    contextInfo - Context information containing the principalId and locale information about the caller of service operation
    
    Returns:
    the list of matching CluResult Ids
    
    Throws:
    
    InvalidParameterException - criteria or contextInfo is null
    
    MissingParameterException - missing criteria or contextInfo
    
    OperationFailedException - unable to complete request
    
    PermissionDeniedException - authorization failure

Interface CluService

Method Summary

Methods inherited from interface org.kuali.student.r2.core.versionmanagement.service.VersionManagementService

Methods inherited from interface org.kuali.student.r2.core.search.service.SearchService

Method Detail

getDeliveryMethodTypes

getDeliveryMethodType

getInstructionalFormatTypes

getInstructionalFormatType

getLuTypes

getLuType

getLuCodeTypes

getLuCodeType

getCluCluRelationTypes

getLuLuRelationType

getAllowedLuLuRelationTypesForLuType

getLuPublicationTypes

getLuPublicationType

getLuPublicationTypesForLuType

getCluResultTypes

getCluResultType

getCluResultTypesForLuType

getResultUsageTypes

getResultUsageType

getAllowedResultUsageTypesForLuType

getAllowedResultComponentTypesForResultUsageType

getCluLoRelationTypes

getCluLoRelationType

getAllowedCluLoRelationTypesForLuType

getCluSetTypes

getCluSetType

getClu

getClusByIds

getClusByLuType

getCluIdsByLuType

getAllowedCluCluRelationTypesByClu

getClusByRelatedCluAndRelationType

getCluIdsByRelatedCluAndRelationType

getRelatedClusByCluAndRelationType

getRelatedCluIdsByCluAndRelationType

getCluCluRelation

getCluCluRelationsByClu

getCluPublicationsByClu

getCluPublicationsByType

getCluPublication

getCluResult

getCluResultByClu

getCluResultsByClus

getCluIdsByResultUsageType

getCluIdsByResultComponent

getCluLoRelation

getCluLoRelationsByClu

getCluLoRelationsByLo

getResourceRequirementsForClu

getCluSet

getCluSetTreeView

getCluSetsByIds

getCluSetIdsFromCluSet

isCluSetDynamic

getClusFromCluSet

getCluIdsFromCluSet

getAllClusInCluSet

getAllCluIdsInCluSet

isCluInCluSet

validateClu

createClu

updateClu

deleteClu

createNewCluVersion

setCurrentCluVersion

updateCluState

validateCluCluRelation

createCluCluRelation

updateCluCluRelation

deleteCluCluRelation

validateCluPublication

createCluPublication

updateCluPublication

deleteCluPublication

validateCluResult