public interface CluService extends VersionManagementService, SearchService
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
|
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
|
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.
|
getCurrentVersion, getCurrentVersionOnDate, getFirstVersion, getLatestVersion, getVersionBySequenceNumber, getVersions, getVersionsInDateRange
getSearchCriteriaTypes, getSearchResultTypes, getSearchType, getSearchTypes, getSearchTypesByCriteria, getSearchTypesByResult, search
List<TypeInfo> getDeliveryMethodTypes(ContextInfo contextInfo) throws InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
contextInfo
- Context information containing the principalId and
locale information about the caller of service
operationInvalidParameterException
- invalid contextInfoMissingParameterException
- missing contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureTypeInfo getDeliveryMethodType(String deliveryMethodTypeKey, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
deliveryMethodTypeKey
- Key of the Delivery Method TypecontextInfo
- Context information containing the
principalId and locale information about the
caller of service operationDoesNotExistException
- deliveryMethodType not foundInvalidParameterException
- invalid contextInfoMissingParameterException
- missing deliveryMethodType or
contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureList<TypeInfo> getInstructionalFormatTypes(ContextInfo contextInfo) throws InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
contextInfo
- Context information containing the principalId and
locale information about the caller of service
operationInvalidParameterException
- invalid contextInfoMissingParameterException
- missing contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureTypeInfo getInstructionalFormatType(String instructionalFormatTypeKey, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
instructionalFormatTypeKey
- Key of the Instructional Format TypecontextInfo
- Context information containing the
principalId and locale information
about the caller of service operationDoesNotExistException
- instructionalFormatTypeKey not foundInvalidParameterException
- invalid contextInfoMissingParameterException
- missing instructionalFormatTypeKey or
contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureList<TypeInfo> getLuTypes(ContextInfo contextInfo) throws InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
contextInfo
- Context information containing the principalId and
locale information about the caller of service
operationInvalidParameterException
- invalid contextInfoMissingParameterException
- missing contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureTypeInfo getLuType(String luTypeKey, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
luTypeKey
- Key of the LU TypecontextInfo
- Context information containing the principalId and
locale information about the caller of service
operationDoesNotExistException
- luTypeKey not foundInvalidParameterException
- invalid contextInfoMissingParameterException
- missing luTypeKey or contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureList<TypeInfo> getLuCodeTypes(ContextInfo contextInfo) throws InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
contextInfo
- Context information containing the principalId and
locale information about the caller of service
operationInvalidParameterException
- invalid contextInfoMissingParameterException
- missing contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureTypeInfo getLuCodeType(String luCodeTypeKey, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
luCodeTypeKey
- Key of the learning unit code typecontextInfo
- Context information containing the principalId and
locale information about the caller of service
operationDoesNotExistException
- luCodeTypeKey not foundInvalidParameterException
- invalid contextInfoMissingParameterException
- missing luCodeTypeKey or contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureList<TypeInfo> getCluCluRelationTypes(ContextInfo contextInfo) throws InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
contextInfo
- Context information containing the principalId and
locale information about the caller of service
operationInvalidParameterException
- invalid contextInfoMissingParameterException
- missing contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureTypeInfo getLuLuRelationType(String cluCluRelationTypeKey, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
cluCluRelationTypeKey
- Key of the LU to LU Relation TypecontextInfo
- Context information containing the
principalId and locale information about the
caller of service operationDoesNotExistException
- cluCluRelationTypeKey not foundInvalidParameterException
- invalid contextInfoMissingParameterException
- missing cluCluRelationTypeKey or
contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureList<String> getAllowedLuLuRelationTypesForLuType(String luTypeKey, String relatedLuTypeKey, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
luTypeKey
- Key of the first LU TyperelatedLuTypeKey
- Key of the second LU TypecontextInfo
- Context information containing the principalId
and locale information about the caller of
service operationDoesNotExistException
- luTypeKey, relatedLuTypeKey not foundInvalidParameterException
- invalid contextInfoMissingParameterException
- missing luTypeKey, relatedLuTypeKey or
contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureList<TypeInfo> getLuPublicationTypes(ContextInfo contextInfo) throws InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
contextInfo
- Context information containing the principalId and
locale information about the caller of service
operationInvalidParameterException
- invalid contextInfoMissingParameterException
- missing contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureTypeInfo getLuPublicationType(String luPublicationTypeKey, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
luPublicationTypeKey
- Key of the Learning Unit Publication TypecontextInfo
- Context information containing the
principalId and locale information about the
caller of service operationDoesNotExistException
- luPublicationTypeKey not foundInvalidParameterException
- invalid contextInfoMissingParameterException
- missing luPublicationTypeKey or
contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureList<String> getLuPublicationTypesForLuType(String luTypeKey, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
luTypeKey
- Key of the LU TypecontextInfo
- Context information containing the principalId and
locale information about the caller of service
operationDoesNotExistException
- luTypeKey not foundInvalidParameterException
- invalid contextInfoMissingParameterException
- missing luTypeKey or contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureList<TypeInfo> getCluResultTypes(ContextInfo contextInfo) throws InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
contextInfo
- Context information containing the principalId and
locale information about the caller of service
operationInvalidParameterException
- invalid contextInfoMissingParameterException
- missing contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureTypeInfo getCluResultType(String cluResultTypeKey, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
cluResultTypeKey
- Key of the Canonical Learning Unit Result TypecontextInfo
- Context information containing the principalId
and locale information about the caller of
service operationDoesNotExistException
- cluResultTypeKey not foundInvalidParameterException
- invalid contextInfoMissingParameterException
- missing cluResultTypeKey or
contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureList<TypeInfo> getCluResultTypesForLuType(String luTypeKey, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
luTypeKey
- luTypeKeycontextInfo
- Context information containing the principalId and
locale information about the caller of service
operationDoesNotExistException
- luTypeKey not foundInvalidParameterException
- invalid contextInfoMissingParameterException
- missing luTypeKey or contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureList<TypeInfo> getResultUsageTypes(ContextInfo contextInfo) throws InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
contextInfo
- Context information containing the principalId and
locale information about the caller of service
operationInvalidParameterException
- invalid contextInfoMissingParameterException
- missing contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureTypeInfo getResultUsageType(String resultUsageTypeKey, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
resultUsageTypeKey
- Key of the Result Usage TypecontextInfo
- Context information containing the principalId
and locale information about the caller of
service operationDoesNotExistException
- resultUsageTypeKey not foundInvalidParameterException
- invalid contextInfoMissingParameterException
- missing resultUsageTypeKey or
contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureList<String> getAllowedResultUsageTypesForLuType(String luTypeKey, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
luTypeKey
- luTypeKeycontextInfo
- Context information containing the principalId and
locale information about the caller of service
operationDoesNotExistException
- luTypeKey not foundInvalidParameterException
- invalid contextInfoMissingParameterException
- missing luTypeKey or contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureList<String> getAllowedResultComponentTypesForResultUsageType(String resultUsageTypeKey, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
resultUsageTypeKey
- resultUsageTypeKeycontextInfo
- Context information containing the principalId
and locale information about the caller of
service operationDoesNotExistException
- resultUsageTypeKey not foundInvalidParameterException
- invalid contextInfoMissingParameterException
- missing resultUsageTypeKey or
contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureList<TypeInfo> getCluLoRelationTypes(ContextInfo contextInfo) throws InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
contextInfo
- Context information containing the principalId and
locale information about the caller of service
operationInvalidParameterException
- invalid contextInfoMissingParameterException
- missing contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureTypeInfo getCluLoRelationType(String cluLoRelationTypeKey, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
cluLoRelationTypeKey
- Key of the CLU to LO Relation TypecontextInfo
- Context information containing the
principalId and locale information about the
caller of service operationDoesNotExistException
- cluLoRelationTypeKey not foundInvalidParameterException
- invalid contextInfoMissingParameterException
- missing cluLoRelationTypeKey or
contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureList<String> getAllowedCluLoRelationTypesForLuType(String luTypeKey, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
luTypeKey
- luTypeKeycontextInfo
- Context information containing the principalId and
locale information about the caller of service
operationDoesNotExistException
- luTypeKey not foundInvalidParameterException
- invalid contextInfoMissingParameterException
- missing luTypeKey or contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureList<TypeInfo> getCluSetTypes(ContextInfo contextInfo) throws InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
contextInfo
- Context information containing the principalId and
locale information about the caller of service
operationInvalidParameterException
- invalid contextInfoMissingParameterException
- missing contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureTypeInfo getCluSetType(String cluSetTypeKey, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
cluSetTypeKey
- Key of the CLU set typecontextInfo
- Context information containing the principalId and
locale information about the caller of service
operationDoesNotExistException
- cluSetTypeKey not foundInvalidParameterException
- invalid contextInfoMissingParameterException
- missing cluSetTypeKey or contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureCluInfo getClu(String cluId, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
cluId
- identifier of the CLUcontextInfo
- Context information containing the principalId and
locale information about the caller of service
operationDoesNotExistException
- cluId not foundInvalidParameterException
- invalid contextInfoMissingParameterException
- missing cluId or contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureList<CluInfo> getClusByIds(List<String> cluIds, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
cluIds
- List of CLU identifierscontextInfo
- Context information containing the principalId and
locale information about the caller of service
operationDoesNotExistException
- One or more cluIds not foundInvalidParameterException
- invalid contextInfoMissingParameterException
- missing cluIds or contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureList<CluInfo> getClusByLuType(String luTypeKey, String luState, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
luTypeKey
- Type of the CLUs to retrieveluState
- State of the CLUs to retrieve.contextInfo
- Context information containing the principalId and
locale information about the caller of service
operationDoesNotExistException
- luTypeKey or luState not foundInvalidParameterException
- invalid contextInfoMissingParameterException
- missing luTypeKey, luState or
contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureList<String> getCluIdsByLuType(String luTypeKey, String luState, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
luTypeKey
- Type of the CLUs whose identifiers should be
retrievedluState
- State of the CLUs whose identifiers should be
retrievedcontextInfo
- Context information containing the principalId and
locale information about the caller of service
operationDoesNotExistException
- luType or luState not foundInvalidParameterException
- invalid contextInfoMissingParameterException
- missing luType, luState or contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureList<String> getAllowedCluCluRelationTypesByClu(String cluId, String relatedCluId, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
cluId
- identifier of the first CLUrelatedCluId
- identifier of the second CLUcontextInfo
- Context information containing the principalId and
locale information about the caller of service
operationDoesNotExistException
- cluId, relatedCluId not foundInvalidParameterException
- invalid contextInfoMissingParameterException
- missing cluId, relatedCluId or
contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureList<CluInfo> getClusByRelatedCluAndRelationType(String relatedCluId, String cluCLuRelationTypeKey, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
relatedCluId
- identifier of the child or To CLUcluCLuRelationTypeKey
- the LU to LU relation typecontextInfo
- Context information containing the
principalId and locale information about the
caller of service operationDoesNotExistException
- relatedCluId, cluCLuRelationTypeKey not
foundInvalidParameterException
- invalid contextInfoMissingParameterException
- missing relatedCluId, cluCLuRelationTypeKey
or contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureList<String> getCluIdsByRelatedCluAndRelationType(String relatedCluId, String cluCluRelationTypeKey, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
relatedCluId
- identifier of the child or To CLUcluCluRelationTypeKey
- the LU to LU relation typecontextInfo
- Context information containing the
principalId and locale information about the
caller of service operationDoesNotExistException
- relatedCluId or cluCluRelationTypeKey
not foundInvalidParameterException
- invalid contextInfoMissingParameterException
- missing relatedCluId, cluCluRelationTypeKey
or contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureList<CluInfo> getRelatedClusByCluAndRelationType(String cluId, String cluCluRelationTypeKey, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
cluId
- identifier of the parent or From CLUcluCluRelationTypeKey
- the LU to LU relation typecontextInfo
- Context information containing the
principalId and locale information about the
caller of service operationDoesNotExistException
- cluId or cluCluRelationTypeKey not
foundInvalidParameterException
- invalid contextInfoMissingParameterException
- missing cluId, cluCluRelationTypeKey or
contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureList<String> getRelatedCluIdsByCluAndRelationType(String cluId, String cluCluRelationTypeKey, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
cluId
- identifier of the parent or From CLUcluCluRelationTypeKey
- the LU to LU relation typecontextInfo
- Context information containing the
principalId and locale information about the
caller of service operationDoesNotExistException
- cluId, cluCluRelationTypeKey not foundInvalidParameterException
- invalid contextInfoMissingParameterException
- missing cluId, cluCluRelationTypeKeyOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureCluCluRelationInfo getCluCluRelation(String cluCluRelationId, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
cluCluRelationId
- identifier of the CLU to CLU relationcontextInfo
- Context information containing the principalId
and locale information about the caller of
service operationDoesNotExistException
- cluCluRelationId not foundInvalidParameterException
- invalid contextInfoMissingParameterException
- missing cluCluRelationId or
contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureList<CluCluRelationInfo> getCluCluRelationsByClu(String cluId, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
cluId
- identifier of the parent or From CLUcontextInfo
- Context information containing the principalId and
locale information about the caller of service
operationDoesNotExistException
- cluId not foundInvalidParameterException
- invalid contextInfoMissingParameterException
- missing cluId or contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureList<CluPublicationInfo> getCluPublicationsByClu(String cluId, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
cluId
- clu identifiercontextInfo
- Context information containing the principalId and
locale information about the caller of service
operationDoesNotExistException
- cluId not foundInvalidParameterException
- invalid contextInfoMissingParameterException
- missing cluId or contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureList<CluPublicationInfo> getCluPublicationsByType(String luPublicationTypeKey, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
luPublicationTypeKey
- luPublicationType identifiercontextInfo
- Context information containing the
principalId and locale information about the
caller of service operationDoesNotExistException
- luPublicationType not foundInvalidParameterException
- invalid contextInfoMissingParameterException
- missing luPublicationTypeKey or
contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureCluPublicationInfo getCluPublication(String cluPublicationId, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
cluPublicationId
- CLU publication identifiercontextInfo
- Context information containing the principalId
and locale information about the caller of
service operationDoesNotExistException
- cluPublicationId not foundInvalidParameterException
- invalid contextInfoMissingParameterException
- missing cluPublicationId or
contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureCluResultInfo getCluResult(String cluResultId, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
cluResultId
- identifier of the Clu ResultcontextInfo
- Context information containing the principalId and
locale information about the caller of service
operationDoesNotExistException
- cluResultId not foundInvalidParameterException
- invalid contextInfoMissingParameterException
- missing cluResultId or contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureList<CluResultInfo> getCluResultByClu(String cluId, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException
cluId
- clu identifiercontextInfo
- Context information containing the principalId and
locale information about the caller of service
operationDoesNotExistException
- cluId not foundInvalidParameterException
- invalid contextInfoMissingParameterException
- missing cluId or contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureList<String> getCluIdsByResultUsageType(String resultUsageTypeKey, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException
resultUsageTypeKey
- identifier of the result usage typecontextInfo
- Context information containing the principalId
and locale information about the caller of
service operationDoesNotExistException
- resultUsageType not foundInvalidParameterException
- invalid resultUsageTypeKeyMissingParameterException
- missing resultUsageTypeKeyOperationFailedException
- unable to complete requestList<String> getCluIdsByResultComponent(String resultComponentId, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException
resultComponentId
- identifier of the result componentcontextInfo
- Context information containing the principalId
and locale information about the caller of
service operationDoesNotExistException
- resultComponent not foundInvalidParameterException
- invalid resultComponentIdMissingParameterException
- missing resultComponentIdOperationFailedException
- unable to complete requestCluLoRelationInfo getCluLoRelation(String cluLoRelationId, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
cluLoRelationId
- Identifier of the CLU LO RelationcontextInfo
- Context information containing the principalId and
locale information about the caller of service
operationDoesNotExistException
- cluLoRelationId not foundInvalidParameterException
- invalid contextInfoMissingParameterException
- missing cluLoRelationId or contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureList<CluLoRelationInfo> getCluLoRelationsByClu(String cluId, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
cluId
- Identifier for the CLUcontextInfo
- Context information containing the principalId and
locale information about the caller of service
operationDoesNotExistException
- cluId not foundInvalidParameterException
- invalid contextInfoMissingParameterException
- missing cluId or contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureList<CluLoRelationInfo> getCluLoRelationsByLo(String loId, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
loId
- Identifier for the learning objectivecontextInfo
- Context information containing the principalId and
locale information about the caller of service
operationDoesNotExistException
- loId not foundInvalidParameterException
- invalid contextInfoMissingParameterException
- missing loId or contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureList<String> getResourceRequirementsForClu(String cluId, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
cluId
- Unique identifier for the CLUcontextInfo
- Context information containing the principalId and
locale information about the caller of service
operationDoesNotExistException
- cluId not foundInvalidParameterException
- invalid contextInfoMissingParameterException
- missing cluId or contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureCluSetInfo getCluSet(String cluSetId, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
cluSetId
- Identifier of the CLU setcontextInfo
- Context information containing the principalId and
locale information about the caller of service
operationDoesNotExistException
- cluSetId not foundInvalidParameterException
- invalid contextInfoMissingParameterException
- missing cluSetId or contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureCluSetTreeViewInfo getCluSetTreeView(String cluSetId, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
cluSetId
- Identifier of the CLU setcontextInfo
- Context information containing the principalId and
locale information about the caller of service
operationDoesNotExistException
- cluSetId not foundInvalidParameterException
- invalid contextInfoMissingParameterException
- missing cluSetId or contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureList<CluSetInfo> getCluSetsByIds(List<String> cluSetIds, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
cluSetIds
- List of identifiers of CLU setscontextInfo
- Context information containing the principalId and
locale information about the caller of service
operationDoesNotExistException
- One or more cluSets not foundInvalidParameterException
- invalid contextInfoMissingParameterException
- missing cluSetIds or contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureList<String> getCluSetIdsFromCluSet(String cluSetId, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
cluSetId
- Identifier of the CLU setcontextInfo
- Context information containing the principalId and
locale information about the caller of service
operationDoesNotExistException
- cluSet not foundInvalidParameterException
- invalid contextInfoMissingParameterException
- missing cluSetId or contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureBoolean isCluSetDynamic(String cluSetId, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
cluSetId
- Identifier of the CLU setcontextInfo
- Context information containing the principalId and
locale information about the caller of service
operationDoesNotExistException
- cluSetId not foundInvalidParameterException
- invalid contextInfoMissingParameterException
- missing cluSetId or contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureList<CluInfo> getClusFromCluSet(String cluSetId, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
cluSetId
- Identifier of the CLU setcontextInfo
- Context information containing the principalId and
locale information about the caller of service
operationDoesNotExistException
- cluSetId not foundInvalidParameterException
- invalid contextInfoMissingParameterException
- missing cluSetId or contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureList<String> getCluIdsFromCluSet(String cluSetId, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
cluSetId
- Identifier of the CLU setcontextInfo
- Context information containing the principalId and
locale information about the caller of service
operationDoesNotExistException
- cluSetId not foundInvalidParameterException
- invalid contextInfoMissingParameterException
- missing cluSetId or contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureList<CluInfo> getAllClusInCluSet(String cluSetId, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
cluSetId
- Identifier of the CLU setcontextInfo
- Context information containing the principalId and
locale information about the caller of service
operationDoesNotExistException
- cluSet not foundInvalidParameterException
- invalid contextInfoMissingParameterException
- missing cluSetId or contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureList<String> getAllCluIdsInCluSet(String cluSetId, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
cluSetId
- Identifier of the CLU setcontextInfo
- Context information containing the principalId and
locale information about the caller of service
operationDoesNotExistException
- cluSetId not foundInvalidParameterException
- invalid contextInfoMissingParameterException
- missing cluSetId or contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureBoolean isCluInCluSet(String cluId, String cluSetId, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
cluId
- Identifier of the CLU to checkcluSetId
- Identifier of the CLU setcontextInfo
- Context information containing the principalId and
locale information about the caller of service
operationDoesNotExistException
- cluId, cluSetId not foundInvalidParameterException
- invalid contextInfoMissingParameterException
- missing cluId, cluSetId or contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureList<ValidationResultInfo> validateClu(String validationTypeKey, CluInfo cluInfo, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
validationTypeKey
- identifier of the extent of validationcluInfo
- CLU information to be tested.contextInfo
- Context information containing the principalId
and locale information about the caller of
service operationDoesNotExistException
- validationTypeKey not foundInvalidParameterException
- invalid cluInfo or contextInfoMissingParameterException
- missing validationTypeKey, cluInfo or
contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureCluInfo createClu(String luTypeKey, CluInfo cluInfo, ContextInfo contextInfo) throws DataValidationErrorException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, ReadOnlyException
luTypeKey
- identifier of the LU Type for the CLU being createdcluInfo
- information about the CLU being createdcontextInfo
- Context information containing the principalId and
locale information about the caller of service
operationDataValidationErrorException
- supplied data is invalidDoesNotExistException
- luTypeKey not foundInvalidParameterException
- invalid cluInfo or contextInfoMissingParameterException
- missing luTypeKey, cluInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureReadOnlyException
- an attempt at supplying information
designated as read onlyCluInfo updateClu(String cluId, CluInfo cluInfo, ContextInfo contextInfo) throws DataValidationErrorException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, ReadOnlyException, VersionMismatchException
cluId
- identifier for the CLU to be updatedcluInfo
- updated information about the CLUcontextInfo
- Context information containing the principalId and
locale information about the caller of service
operationDataValidationErrorException
- supplied data is invalidDoesNotExistException
- cluId not foundInvalidParameterException
- invalid cluInfo or contextInfoMissingParameterException
- missing cluId, cluInfo or
contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureReadOnlyException
- an attempt at supplying information
designated as read onlyVersionMismatchException
- an optimistic locking failure or the
action was attempted on an out of
date versionStatusInfo deleteClu(String cluId, ContextInfo contextInfo) throws DependentObjectsExistException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
cluId
- identifier for the CLU to be deletedcontextInfo
- Context information containing the principalId and
locale information about the caller of service
operationDependentObjectsExistException
- delete would leave orphaned
objects or violate integrity
constraintsDoesNotExistException
- cluId not foundInvalidParameterException
- invalid contextInfoMissingParameterException
- missing cluId or contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureCluInfo createNewCluVersion(String cluId, String versionComment, ContextInfo contextInfo) throws DataValidationErrorException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, ReadOnlyException
cluId
- identifier for the CLU to be versionedversionComment
- comment for the current versioncontextInfo
- Context information containing the principalId and
locale information about the caller of service
operationDataValidationErrorException
- supplied data is invalidDoesNotExistException
- cluId not foundInvalidParameterException
- invalid contextInfoMissingParameterException
- missing cluId, versionComment or
contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureReadOnlyException
- an attempt at supplying information
designated as read onlyStatusInfo setCurrentCluVersion(String cluVersionId, Date currentVersionStart, ContextInfo contextInfo) throws DataValidationErrorException, DoesNotExistException, InvalidParameterException, MissingParameterException, IllegalVersionSequencingException, OperationFailedException, PermissionDeniedException
cluVersionId
- Version Specific Id of the ClucurrentVersionStart
- 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 operationDataValidationErrorException
- supplied data is invalidDoesNotExistException
- cluVersionId not foundInvalidParameterException
- invalid contextInfoMissingParameterException
- missing cluVersionId, previousState,
newStateIllegalVersionSequencingException
- a Clu with higher sequence number
from the one provided is marked
currentOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureCluInfo updateCluState(String cluId, String luState, ContextInfo contextInfo) throws DataValidationErrorException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, ReadOnlyException, VersionMismatchException
cluId
- identifier for the CLU to be updatedluState
- 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
operationDataValidationErrorException
- supplied data is invalidDoesNotExistException
- cluId not foundInvalidParameterException
- invalid contextInfoMissingParameterException
- missing cluId, luState or
contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureReadOnlyException
- an attempt at supplying information
designated as read onlyVersionMismatchException
- an optimistic locking failure or the
action was attempted on an out of
date versionList<ValidationResultInfo> validateCluCluRelation(String validationTypeKey, String cluId, String relatedCluId, String cluCluRelationTypeKey, CluCluRelationInfo cluCluRelationInfo, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
validationTypeKey
- identifier of the extent of validationcluId
- identifier of the first CLU in the
relationship - The From or Parent of the
relationrelatedCluId
- identifier of the second CLU in the
relationship to be related to - the To or
Child of the RelationcluCluRelationTypeKey
- the CLU to CLU relationship type of the
relationshipcluCluRelationInfo
- cluCluRelation information to be tested.contextInfo
- Context information containing the
principalId and locale information about the
caller of service operationDoesNotExistException
- validationTypeKey, cluId, relatedCluId
or cluCluRelationTypeKey not foundInvalidParameterException
- invalid cluCluRelationInfo or
contextInfoMissingParameterException
- missing validationTypeKey, cluId,
relatedCluId, cluCluRelationTypeKey or
cluCluRelationInfo or contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureCluCluRelationInfo createCluCluRelation(String cluId, String relatedCluId, String cluCluRelationTypeKey, CluCluRelationInfo cluCluRelationInfo, ContextInfo contextInfo) throws CircularRelationshipException, DataValidationErrorException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, ReadOnlyException
cluId
- identifier of the first CLU in the
relationship - The From or Parent of the
relationrelatedCluId
- identifier of the second CLU in the
relationship to be related to - the To or
Child of the RelationcluCluRelationTypeKey
- the LU to LU relationship type of the
relationshipcluCluRelationInfo
- information about the relationship between
the two CLUscontextInfo
- Context information containing the
principalId and locale information about the
caller of service operationCircularRelationshipException
- cluId equals relatedCluIdDataValidationErrorException
- One or more values invalid for this
operationDoesNotExistException
- cluId, relatedCluId, cluCluRelationTypeKey
not foundInvalidParameterException
- invalid cluCluRelationInfo or
contextInfoMissingParameterException
- missing cluId, relatedCluId,
cluCluRelationTypeKey, cluCluRelationInfo
or contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureReadOnlyException
- an attempt at supplying information
designated as read onlyCluCluRelationInfo updateCluCluRelation(String cluCluRelationId, CluCluRelationInfo cluCluRelationInfo, ContextInfo contextInfo) throws DataValidationErrorException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, ReadOnlyException, VersionMismatchException
cluCluRelationId
- identifier of the CLU to CLU relation to be
updatedcluCluRelationInfo
- changed information about the CLU to CLU
relationshipcontextInfo
- Context information containing the principalId
and locale information about the caller of
service operationDataValidationErrorException
- One or more values invalid for this
operationDoesNotExistException
- cluCluRelation not foundInvalidParameterException
- invalid cluCluRelationInfo or
contextInfoMissingParameterException
- missing cluCluRelationId,
cluCluRelationInfo or contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureReadOnlyException
- an attempt at supplying information
designated as read onlyVersionMismatchException
- an optimistic locking failure or the
action was attempted on an out of
date versionStatusInfo deleteCluCluRelation(String cluCluRelationId, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
cluCluRelationId
- identifier of CLU to CLU relationship to deletecontextInfo
- Context information containing the principalId
and locale information about the caller of
service operationDoesNotExistException
- cluCluRelationId not foundInvalidParameterException
- invalid contextInfoMissingParameterException
- missing cluCluRelationId or
contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureList<ValidationResultInfo> validateCluPublication(String validationTypeKey, String cluId, String luPublicationTypeKey, CluPublicationInfo cluPublicationInfo, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
validationTypeKey
- identifier of the extent of validationcluId
- identifier of a cluluPublicationTypeKey
- type of lu publicationcluPublicationInfo
- CLU publication information to be tested.contextInfo
- Context information containing the
principalId and locale information about the
caller of service operationDoesNotExistException
- validationTypeKey, cluId or
luPublicationTypeKey not foundInvalidParameterException
- invalid cluPublicationInfo or
contextInfoMissingParameterException
- missing validationTypeKey, cluId,
luPublicationTypeKey, cluPublicationInfo
or contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureCluPublicationInfo createCluPublication(String cluId, String luPublicationTypeKey, CluPublicationInfo cluPublicationInfo, ContextInfo contextInfo) throws DataValidationErrorException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, ReadOnlyException
cluId
- identifier of a cluluPublicationTypeKey
- type of lu publicationcluPublicationInfo
- information about publication for a clucontextInfo
- Context information containing the
principalId and locale information about the
caller of service operationDataValidationErrorException
- supplied data is invalidDoesNotExistException
- cluId or luPublicationTypeKey not
foundInvalidParameterException
- invalid cluPublicationInfo or
contextInfoMissingParameterException
- missing cluId, luPublicationTypeKey,
cluPublicationInfo or contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureReadOnlyException
- an attempt at supplying information
designated as read onlyCluPublicationInfo updateCluPublication(String cluPublicationId, CluPublicationInfo cluPublicationInfo, ContextInfo contextInfo) throws DataValidationErrorException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, ReadOnlyException, VersionMismatchException
cluPublicationId
- identifier for the clu publication object to be
updatedcluPublicationInfo
- updated information about the clu publication
objectcontextInfo
- Context information containing the principalId
and locale information about the caller of
service operationDataValidationErrorException
- supplied data is invalidDoesNotExistException
- cluPublicationId not foundInvalidParameterException
- invalid cluPublicationInfo or
contextInfoMissingParameterException
- missing cluPublicationId,
cluPublicationInfo or contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureReadOnlyException
- an attempt at supplying information
designated as read onlyVersionMismatchException
- The action was attempted on an out
of date version.StatusInfo deleteCluPublication(String cluPublicationId, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, DependentObjectsExistException, OperationFailedException, PermissionDeniedException
cluPublicationId
- identifier for the clu publication object to be
deletedcontextInfo
- Context information containing the principalId
and locale information about the caller of
service operationDependentObjectsExistException
- delete would leave orphaned
objects or violate integrity
constraintsDoesNotExistException
- cluPublicationId not foundInvalidParameterException
- invalid contextInfoMissingParameterException
- missing cluPublicationId or
contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureList<ValidationResultInfo> validateCluResult(String validationTypeKey, String cluId, String cluResultTypeKey, CluResultInfo cluResultInfo, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
validationTypeKey
- identifier of the extent of validationcluId
- identifier of a clucluResultTypeKey
- type of clu resultcluResultInfo
- CLU result information to be tested.contextInfo
- Context information containing the principalId
and locale information about the caller of
service operationDoesNotExistException
- validationTypeKey, cluId or
cluResultTypeKey not foundInvalidParameterException
- invalid cluResultInfo or contextInfoMissingParameterException
- missing validationTypeKey, cluId,
cluResultTypeKey, cluResultInfo or
contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureCluResultInfo createCluResult(String cluId, String cluResultTypeKey, CluResultInfo cluResultInfo, ContextInfo contextInfo) throws DataValidationErrorException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, ReadOnlyException
cluId
- identifier of a clucluResultTypeKey
- type of clu resultcluResultInfo
- information about potential results for a clucontextInfo
- Context information containing the principalId
and locale information about the caller of
service operationDataValidationErrorException
- supplied data is invalidDoesNotExistException
- cluId or resultUsageTypeKey not
foundInvalidParameterException
- invalid cluResultInfo or contextInfoMissingParameterException
- missing cluId, cluResultTypeKey,
cluResultInfo or contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureReadOnlyException
- an attempt at supplying information
designated as read onlyCluResultInfo updateCluResult(String cluResultId, CluResultInfo cluResultInfo, ContextInfo contextInfo) throws DataValidationErrorException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, ReadOnlyException, VersionMismatchException
cluResultId
- identifier for the clu result to be updatedcluResultInfo
- updated information about the clu resultcontextInfo
- Context information containing the principalId and
locale information about the caller of service
operationDataValidationErrorException
- One or more values invalid for this
operationDoesNotExistException
- cluResultId not foundInvalidParameterException
- invalid contextInfoMissingParameterException
- missing cluResultId, cluResultInfo
or contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureReadOnlyException
- an attempt at supplying information
designated as read onlyVersionMismatchException
- an optimistic locking failure or the
action was attempted on an out of
date versionStatusInfo deleteCluResult(String cluResultId, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, DependentObjectsExistException, OperationFailedException, PermissionDeniedException
cluResultId
- identifier for the clu result to be deletedcontextInfo
- Context information containing the principalId and
locale information about the caller of service
operationDoesNotExistException
- cluResultId not foundInvalidParameterException
- invalid contextInfoMissingParameterException
- missing cluResultId or contextInfoDependentObjectsExistException
- delete would leave orphaned
objects or violate integrity
constraintsOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureList<ValidationResultInfo> validateCluLoRelation(String validationTypeKey, String cluId, String loId, String cluLoRelationTypeKey, CluLoRelationInfo cluLoRelationInfo, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
validationTypeKey
- identifier of the extent of validationcluId
- CLU identifierloId
- learning objective identifiercluLoRelationTypeKey
- type of clu learning objective relationshipcluLoRelationInfo
- cluLoRelation information to be tested.contextInfo
- Context information containing the
principalId and locale information about the
caller of service operationDoesNotExistException
- validationTypeKey, cluId, loId or
cluLoRelationTypeKey not foundInvalidParameterException
- invalid cluLoRelationInfo or
contextInfoMissingParameterException
- missing validationTypeKey, cluId, loId,
cluLoRelationTypeKey, cluLoRelationInfo
or contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureCluLoRelationInfo createCluLoRelation(String cluId, String loId, String cluLoRelationTypeKey, CluLoRelationInfo cluLoRelationInfo, ContextInfo contextInfo) throws DataValidationErrorException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, ReadOnlyException
cluId
- CLU identifierloId
- learning objective identifiercluLoRelationTypeKey
- type of clu learning objective relationshipcluLoRelationInfo
- clu learning objective relationship
informationcontextInfo
- Context information containing the
principalId and locale information about the
caller of service operationDataValidationErrorException
- data validation errorDoesNotExistException
- cluId, loId, cluLoRelationTypeKey
not foundInvalidParameterException
- invalid cluLoRelationInfo or
contextInfoMissingParameterException
- missing cluId, loId, cluLoRelationTypeKey,
cluLoRelationInfo or contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureReadOnlyException
- an attempt at supplying information
designated as read onlyCluLoRelationInfo updateCluLoRelation(String cluLoRelationId, CluLoRelationInfo cluLoRelationInfo, ContextInfo contextInfo) throws DataValidationErrorException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, ReadOnlyException, VersionMismatchException
cluLoRelationId
- identifier of the clu learning objective
relationship to be updatedcluLoRelationInfo
- information about the clu learning objective
relationship to be updatedcontextInfo
- Context information containing the principalId
and locale information about the caller of
service operationDataValidationErrorException
- data validation errorDoesNotExistException
- cluLoRelationId not foundInvalidParameterException
- invalid cluLoRelationInfo or
contextInfoMissingParameterException
- missing cluLoRelationId, cluLoRelationInfo
or contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureReadOnlyException
- an attempt at supplying information
designated as read onlyVersionMismatchException
- The action was attempted on an out
of date version.StatusInfo deleteCluLoRelation(String cluLoRelationId, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
cluLoRelationId
- CLU learning objective Relationship identifiercontextInfo
- Context information containing the principalId and
locale information about the caller of service
operationDoesNotExistException
- cluLoRelationId not foundInvalidParameterException
- invalid contextInfoMissingParameterException
- missing cluLoRelationIdOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureStatusInfo addCluResourceRequirement(String resourceTypeKey, String cluId, ContextInfo contextInfo) throws AlreadyExistsException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
resourceTypeKey
- identifier of the resource requirement type to be
added to the CLUcluId
- identifier of the CLUcontextInfo
- Context information containing the principalId and
locale information about the caller of service
operationAlreadyExistsException
- if the resource type has already been added to the cluDoesNotExistException
- resourceTypeKey or cluId not foundInvalidParameterException
- invalid resourceTypeKey or cluIdMissingParameterException
- missing resourceTypeKey, cluId or
contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureStatusInfo removeCluResourceRequirement(String resourceTypeKey, String cluId, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
resourceTypeKey
- identifier of the resource type to be removed from
the CLUcluId
- identifier of the CLUcontextInfo
- Context information containing the principalId and
locale information about the caller of service
operationDoesNotExistException
- resourceTypeKey or cluId not foundInvalidParameterException
- invalid contextInfoMissingParameterException
- missing resourceTypeKey, cluId or
contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureList<ValidationResultInfo> validateCluSet(String validationTypeKey, String cluSetTypeKey, CluSetInfo cluSetInfo, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
validationTypeKey
- identifier of the extent of validationcluSetTypeKey
- type of the CLU set to be createdcluSetInfo
- CLU set information to be tested.contextInfo
- Context information containing the principalId
and locale information about the caller of
service operationDoesNotExistException
- validationTypeKey or cluSetTypeKey not
foundInvalidParameterException
- invalid cluSetInfo or contextInfoMissingParameterException
- missing validationTypeKey, cluSetTypeKey,
cluSetInfo or contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureCluSetInfo createCluSet(String cluSetTypeKey, CluSetInfo cluSetInfo, ContextInfo contextInfo) throws DataValidationErrorException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, ReadOnlyException, UnsupportedActionException
cluSetTypeKey
- type of the CLU set to be createdcluSetInfo
- information required to create a CLU setcontextInfo
- Context information containing the principalId and
locale information about the caller of service
operationDataValidationErrorException
- data validation errorDoesNotExistException
- cluSetTypeKey not foundInvalidParameterException
- invalid cluSetInfo or contextInfoMissingParameterException
- missing cluSetTypeKey, cluSetInfo or
contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureReadOnlyException
- an attempt at supplying information
designated as read onlyUnsupportedActionException
- CLU set need to be static or dynamic
but not bothCluSetInfo updateCluSet(String cluSetId, CluSetInfo cluSetInfo, ContextInfo contextInfo) throws CircularRelationshipException, DataValidationErrorException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, ReadOnlyException, UnsupportedActionException, VersionMismatchException
cluSetId
- identifier of the CLU set to be updatedcluSetInfo
- updated information about the CLU setcontextInfo
- Context information containing the principalId and
locale information about the caller of service
operationCircularRelationshipException
- added CluSetId cannot be added to
the cluSetInfoDataValidationErrorException
- data validation errorDoesNotExistException
- cluSetId not foundInvalidParameterException
- invalid cluSetInfo or contextInfoMissingParameterException
- missing cluSetId, cluSetInfo or
contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureReadOnlyException
- an attempt at supplying information
designated as read onlyUnsupportedActionException
- CLU set need to be static or
dynamic but not bothVersionMismatchException
- an optimistic locking failure or
the action was attempted on an out
of date versionStatusInfo deleteCluSet(String cluSetId, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
cluSetId
- identifier of the CLU set to be deletedcontextInfo
- Context information containing the principalId and
locale information about the caller of service
operationDoesNotExistException
- cluSetId not foundInvalidParameterException
- invalid contextInfoMissingParameterException
- missing cluSetId or contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureStatusInfo addCluSetToCluSet(String cluSetId, String addedCluSetId, ContextInfo contextInfo) throws CircularRelationshipException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, UnsupportedActionException
cluSetId
- identifier of the host CLU setaddedCluSetId
- identifier of the CLU set to be addedcontextInfo
- Context information containing the principalId and
locale information about the caller of service
operationCircularRelationshipException
- addedCluSetId cannot be added to
the CluSetIdDoesNotExistException
- cluSetId, addedCluSetId not foundInvalidParameterException
- invalid contextInfoMissingParameterException
- missing cluSetId, addedCluSetId or
contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedActionException
- CLU set is dynamically determinedStatusInfo addCluSetsToCluSet(String cluSetId, List<String> addedCluSetIds, ContextInfo contextInfo) throws CircularRelationshipException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, UnsupportedActionException
cluSetId
- identifier of the host CLU setaddedCluSetIds
- list of identifiers of the CLU sets to be addedcontextInfo
- Context information containing the principalId and
locale information about the caller of service
operationCircularRelationshipException
- addedCluSetIds cannot be added to
the cluSetIdDoesNotExistException
- cluSetId, one or more of cluSetIds
in addedCluSetIds not foundInvalidParameterException
- invalid contextInfoMissingParameterException
- missing cluSetId, addedCluSetIds or
contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedActionException
- CLU set is dynamically determinedStatusInfo removeCluSetFromCluSet(String cluSetId, String removedCluSetId, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, UnsupportedActionException
cluSetId
- identifier of the host CLU setremovedCluSetId
- identifier of the CLU set to be removedcontextInfo
- Context information containing the principalId and
locale information about the caller of service
operationDoesNotExistException
- cluSetId, removedCluSetId not foundInvalidParameterException
- invalid contextInfoMissingParameterException
- missing cluSetId, removedCluSetId or
contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedActionException
- CLU set is dynamically determinedStatusInfo addCluToCluSet(String cluId, String cluSetId, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, UnsupportedActionException
cluId
- identifier of CLU to add to the CLU setcluSetId
- identifier of the CLU setcontextInfo
- Context information containing the principalId and
locale information about the caller of service
operationDoesNotExistException
- cluId, cluSetId not foundInvalidParameterException
- invalid contextInfoMissingParameterException
- missing cluId, cluSetId or
contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedActionException
- CLU set is dynamically determinedStatusInfo addClusToCluSet(List<String> cluSetIds, String cluSetId, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, UnsupportedActionException
cluSetIds
- list of identifiers of CLUs to add to the CLU setcluSetId
- identifier of the CLU set to be addedcontextInfo
- Context information containing the principalId and
locale information about the caller of service
operationDoesNotExistException
- cluSetIds, cluSetId not foundInvalidParameterException
- invalid contextInfoMissingParameterException
- missing cluSetIds, cluSetId or
contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedActionException
- CLU set is dynamically determinedStatusInfo removeCluFromCluSet(String cluId, String cluSetId, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, UnsupportedActionException
cluId
- identifier of CLU to remove from the CLU setcluSetId
- identifier of the CLU setcontextInfo
- Context information containing the principalId and
locale information about the caller of service
operationDoesNotExistException
- cluId, cluSetId not foundInvalidParameterException
- invalid contextInfoMissingParameterException
- missing cluId, cluSetId or
contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedActionException
- CLU set is dynamically determinedCopyright © 2004-2013 The Kuali Foundation. All Rights Reserved.