CluService

• 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
• 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
• createCluResult
• updateCluResult
• deleteCluResult
• validateCluLoRelation
• createCluLoRelation
• updateCluLoRelation
• deleteCluLoRelation
• addCluResourceRequirement
• removeCluResourceRequirement
• validateCluSet
• createCluSet
• updateCluSet
• deleteCluSet
• addCluSetToCluSet
• addCluSetsToCluSet
• removeCluSetFromCluSet
• addCluToCluSet
• addClusToCluSet
• removeCluFromCluSet
• search
• getSearchCriteriaType
• getSearchCriteriaTypes
• getSearchResultType
• getSearchResultTypes
• getSearchType
• getSearchTypes
• getSearchTypesByCriteria
• getSearchTypesByResult

• TypeInfo
• ContextInfo
• CluInfo
• CluCluRelationInfo
• CluPublicationInfo
• CluResultInfo
• CluLoRelationInfo
• CluSetInfo
• CluSetTreeViewInfo
• ValidationResultInfo
• StatusInfo
• SearchResult
• SearchRequest
• SearchCriteriaTypeInfo
• SearchResultTypeInfo
• SearchTypeInfo

Method	getDeliveryMethodTypes
Description	Retrieves the list of delivery method types
Parameters	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	TypeInfoList		list of delivery method type information
Errors	InvalidParameterException		invalid contextInfo
	MissingParameterException		missing contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getDeliveryMethodType
Description	Retrieves information about a delivery method type
Parameters	String	deliveryMethodTypeKey	Key of the Delivery Method Type
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	TypeInfo		information about a Delivery Method Type
Errors	DoesNotExistException		deliveryMethodType not found
	InvalidParameterException		invalid contextInfo
	MissingParameterException		missing deliveryMethodType or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getInstructionalFormatTypes
Description	Retrieves the list of instructional format types
Parameters	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	TypeInfoList		list of instructional format type information
Errors	InvalidParameterException		invalid contextInfo
	MissingParameterException		missing contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getInstructionalFormatType
Description	Retrieves information about a Instructional Format Type
Parameters	String	instructionalFormatTypeKey	Key of the Instructional Format Type
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	TypeInfo		information about a Instructional Format Type
Errors	DoesNotExistException		instructionalFormatTypeKey not found
	InvalidParameterException		invalid contextInfo
	MissingParameterException		missing instructionalFormatTypeKey or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getLuTypes
Description	Retrieves the list of LU types
Parameters	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	TypeInfoList		list of LU type information
Errors	InvalidParameterException		invalid contextInfo
	MissingParameterException		missing contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getLuType
Description	Retrieves information about a LU Type
Parameters	String	luTypeKey	Key of the LU Type
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	TypeInfo		information about a LU Type
Errors	DoesNotExistException		luTypeKey not found
	InvalidParameterException		invalid contextInfo
	MissingParameterException		missing luTypeKey or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getLuCodeTypes
Description	Retrieves the list of learning unit code types
Parameters	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	TypeInfoList		list of lu code type information
Errors	InvalidParameterException		invalid contextInfo
	MissingParameterException		missing contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getLuCodeType
Description	Retrieves information about a learning unit code type
Parameters	String	luCodeTypeKey	Key of the learning unit code type
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	TypeInfo		information about a learning unit code type
Errors	DoesNotExistException		luCodeTypeKey not found
	InvalidParameterException		invalid contextInfo
	MissingParameterException		missing luCodeTypeKey or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getCluCluRelationTypes
Description	Retrieves the complete list of LU to LU relation types
Parameters	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	TypeInfoList		list of LU to LU relation type information
Errors	InvalidParameterException		invalid contextInfo
	MissingParameterException		missing contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getLuLuRelationType
Description	Retrieves the LU to LU relation type
Parameters	String	cluCluRelationTypeKey	Key of the LU to LU Relation Type
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	TypeInfo		LU to LU relation type information
Errors	DoesNotExistException		cluCluRelationTypeKey not found
	InvalidParameterException		invalid contextInfo
	MissingParameterException		missing cluCluRelationTypeKey or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getAllowedLuLuRelationTypesForLuType
Description	Retrieves the list of allowed relation types between the two specified LU Types
Parameters	String	luTypeKey	Key of the first LU Type
	String	relatedLuTypeKey	Key of the second LU Type
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StringList		list of LU to LU relation types
Errors	DoesNotExistException		luTypeKey, relatedLuTypeKey not found
	InvalidParameterException		invalid contextInfo
	MissingParameterException		missing luTypeKey, relatedLuTypeKey or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getLuPublicationTypes
Description	Retrieves the list of Learning Unit publication types
Parameters	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	TypeInfoList		list of Learning Unit publication type information
Errors	InvalidParameterException		invalid contextInfo
	MissingParameterException		missing contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getLuPublicationType
Description	Retrieves information about a publication type
Parameters	String	luPublicationTypeKey	Key of the Learning Unit Publication Type
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	TypeInfo		information about a Learning Unit Publication Type
Errors	DoesNotExistException		luPublicationTypeKey not found
	InvalidParameterException		invalid contextInfo
	MissingParameterException		missing luPublicationTypeKey or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getLuPublicationTypesForLuType
Description	Retrieves information about a publication type
Parameters	String	luTypeKey	Key of the LU Type
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StringList		list of LU publication types
Errors	DoesNotExistException		luTypeKey not found
	InvalidParameterException		invalid contextInfo
	MissingParameterException		missing luTypeKey or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getCluResultTypes
Description	Retrieves a list of types for clu result objects.
Parameters	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	TypeInfoList		list of clu result type information
Errors	InvalidParameterException		invalid contextInfo
	MissingParameterException		missing contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getCluResultType
Description	Retrieves information about a publication type
Parameters	String	cluResultTypeKey	Key of the Canonical Learning Unit Result Type
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	TypeInfo		information about a Learning Unit Publication Type
Errors	DoesNotExistException		cluResultTypeKey not found
	InvalidParameterException		invalid contextInfo
	MissingParameterException		missing cluResultTypeKey or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getCluResultTypesForLuType
Description	Retrieves the list of clu result types which are allowed to be used in conjunction with a particular lu type.
Parameters	String	luTypeKey	luTypeKey
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	TypeInfoList		list of clu result types
Errors	DoesNotExistException		luTypeKey not found
	InvalidParameterException		invalid contextInfo
	MissingParameterException		missing luTypeKey or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getResultUsageTypes
Description	Retrieves a list of result usage types
Parameters	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	TypeInfoList		list of result usage type information
Errors	InvalidParameterException		invalid contextInfo
	MissingParameterException		missing contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getResultUsageType
Description	Retrieves information about a Result Usage Type
Parameters	String	resultUsageTypeKey	Key of the Result Usage Type
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	TypeInfo		information about a Result Usage Type
Errors	DoesNotExistException		resultUsageTypeKey not found
	InvalidParameterException		invalid contextInfo
	MissingParameterException		missing resultUsageTypeKey or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getAllowedResultUsageTypesForLuType
Description	Retrieves the list of result usage types which are allowed to be used in conjunction with an lu type.
Parameters	String	luTypeKey	luTypeKey
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StringList		list of result usage types
Errors	DoesNotExistException		luTypeKey not found
	InvalidParameterException		invalid contextInfo
	MissingParameterException		missing luTypeKey or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getAllowedResultComponentTypesForResultUsageType
Description	Retrieves the list of result component types which are allowed to be used in conjunction with result usage type.
Parameters	String	resultUsageTypeKey	resultUsageTypeKey
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StringList		list of result component types
Errors	DoesNotExistException		resultUsageTypeKey not found
	InvalidParameterException		invalid contextInfo
	MissingParameterException		missing resultUsageTypeKey or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getCluLoRelationTypes
Description	Retrieves the complete list of CLU to LO relation types
Parameters	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	TypeInfoList		list of CLU to LO relation type information
Errors	InvalidParameterException		invalid contextInfo
	MissingParameterException		missing contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getCluLoRelationType
Description	Retrieves information for a specified CLU to LO relation type
Parameters	String	cluLoRelationTypeKey	Key of the CLU to LO Relation Type
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	TypeInfo		CLU to LO relation type information
Errors	DoesNotExistException		cluLoRelationTypeKey not found
	InvalidParameterException		invalid contextInfo
	MissingParameterException		missing cluLoRelationTypeKey or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getAllowedCluLoRelationTypesForLuType
Description	Retrieves the list of CLU LO relation types which are allowed to be used in conjunction with an lu type.
Parameters	String	luTypeKey	luTypeKey
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StringList		list of clu lo relation types
Errors	DoesNotExistException		luTypeKey not found
	InvalidParameterException		invalid contextInfo
	MissingParameterException		missing luTypeKey or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getCluSetTypes
Description	Retrieves the list of CLU set types known by the service
Parameters	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	TypeInfoList		list of CLU set type information
Errors	InvalidParameterException		invalid contextInfo
	MissingParameterException		missing contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getCluSetType
Description	Retrieves information about a specified CLU set type
Parameters	String	cluSetTypeKey	Key of the CLU set type
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	TypeInfo		information about a CLU set type
Errors	DoesNotExistException		cluSetTypeKey not found
	InvalidParameterException		invalid contextInfo
	MissingParameterException		missing cluSetTypeKey or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getClu
Description	Retrieves core information about a CLU
Parameters	String	cluId	identifier of the CLU
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	CluInfo		information about a CLU
Errors	DoesNotExistException		cluId not found
	InvalidParameterException		invalid contextInfo
	MissingParameterException		missing cluId or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getClusByIds
Description	Retrieves information about CLUs from a list of Ids
Parameters	StringList	cluIds	List of CLU identifiers
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	CluInfoList		information a list of CLUs
Errors	DoesNotExistException		One or more cluIds not found
	InvalidParameterException		invalid contextInfo
	MissingParameterException		missing cluIds or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getClusByLuType
Description	Retrieves the list of CLUs for the specified LU Type and state
Parameters	String	luTypeKey	Type of the CLUs to retrieve
	String	luState	State of the CLUs to retrieve.
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	CluInfoList		list of CLU information
Errors	DoesNotExistException		luTypeKey or luState not found
	InvalidParameterException		invalid contextInfo
	MissingParameterException		missing luTypeKey, luState or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getCluIdsByLuType
Description	Retrieves the list of CLU Ids for the specified LU Type and state
Parameters	String	luTypeKey	Type of the CLUs whose identifiers should be retrieved
	String	luState	State of the CLUs whose identifiers should be retrieved
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StringList		list of CLU identifiers
Errors	DoesNotExistException		luType or luState not found
	InvalidParameterException		invalid contextInfo
	MissingParameterException		missing luType, luState or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getAllowedCluCluRelationTypesByClu
Description	Retrieves the list of allowed relation types between the two specified CLUs
Parameters	String	cluId	identifier of the first CLU
	String	relatedCluId	identifier of the second CLU
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StringList		list of LU to LU relation types
Errors	DoesNotExistException		cluId, relatedCluId not found
	InvalidParameterException		invalid contextInfo
	MissingParameterException		missing cluId, relatedCluId or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getClusByRelatedCluAndRelationType
Description	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	String	relatedCluId	identifier of the child or To CLU
	String	cluCLuRelationTypeKey	the LU to LU relation type
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	CluInfoList		list of CLU information
Errors	DoesNotExistException		relatedCluId, cluCLuRelationTypeKey not found
	InvalidParameterException		invalid contextInfo
	MissingParameterException		missing relatedCluId, cluCLuRelationTypeKey or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getCluIdsByRelatedCluAndRelationType
Description	Retrieves the list of CLU Ids for the specified related CLU Id and LU to LU relation type (getRelatedCluIdsByCluAndRelationType from the other direction)
Parameters	String	relatedCluId	identifier of the child or To CLU
	String	cluCluRelationTypeKey	the LU to LU relation type
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StringList		list of CLU identifiers
Errors	DoesNotExistException		relatedCluId or cluCluRelationTypeKey not found
	InvalidParameterException		invalid contextInfo
	MissingParameterException		missing relatedCluId, cluCluRelationTypeKey or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getRelatedClusByCluAndRelationType
Description	Retrieves the list of related CLU information for the specified CLU Id and LU to LU relation type (getClusByRelation from the other direction)
Parameters	String	cluId	identifier of the parent or From CLU
	String	cluCluRelationTypeKey	the LU to LU relation type
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	CluInfoList		list of CLU information
Errors	DoesNotExistException		cluId or cluCluRelationTypeKey not found
	InvalidParameterException		invalid contextInfo
	MissingParameterException		missing cluId, cluCluRelationTypeKey or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getRelatedCluIdsByCluAndRelationType
Description	Retrieves the list of related CLU Ids for the specified CLU Id and LU to LU relation type (getCluIdsByRelatedCluAndCluCluRelationType from the other direction)
Parameters	String	cluId	identifier of the parent or From CLU
	String	cluCluRelationTypeKey	the LU to LU relation type
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StringList		list of CLU identifiers
Errors	DoesNotExistException		cluId, cluCluRelationTypeKey not found
	InvalidParameterException		invalid contextInfo
	MissingParameterException		missing cluId, cluCluRelationTypeKey
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getCluCluRelation
Description	Retrieves the relationship information between CLUs for a particular Relation instance
Parameters	String	cluCluRelationId	identifier of the CLU to CLU relation
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	CluCluRelationInfo		information on the relation between two CLUs
Errors	DoesNotExistException		cluCluRelationId not found
	InvalidParameterException		invalid contextInfo
	MissingParameterException		missing cluCluRelationId or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getCluCluRelationsByClu
Description	Retrieves the list of relationship information for the specified CLU
Parameters	String	cluId	identifier of the parent or From CLU
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	CluCluRelationInfoList		list of CLU to CLU relation information
Errors	DoesNotExistException		cluId not found
	InvalidParameterException		invalid contextInfo
	MissingParameterException		missing cluId or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getCluPublicationsByClu
Description	Retrieves a list of publication objects for a particular clu
Parameters	String	cluId	clu identifier
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	CluPublicationInfoList		list of publication objects used by the specified clu
Errors	DoesNotExistException		cluId not found
	InvalidParameterException		invalid contextInfo
	MissingParameterException		missing cluId or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getCluPublicationsByType
Description	Retrieves a list of publication objects of a particular Type
Parameters	String	luPublicationTypeKey	luPublicationType identifier
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	CluPublicationInfoList		list of CLU Publication objects using the specified type
Errors	DoesNotExistException		luPublicationType not found
	InvalidParameterException		invalid contextInfo
	MissingParameterException		missing luPublicationTypeKey or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getCluPublication
Description	Retrieves an LU publication object by its identifier
Parameters	String	cluPublicationId	CLU publication identifier
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	CluPublicationInfo		CLU Publication information
Errors	DoesNotExistException		cluPublicationId not found
	InvalidParameterException		invalid contextInfo
	MissingParameterException		missing cluPublicationId or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getCluResult
Description	Retrieves information about a Clu Result
Parameters	String	cluResultId	identifier of the Clu Result
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	CluResultInfo		information about a Clu Result
Errors	DoesNotExistException		cluResultId not found
	InvalidParameterException		invalid contextInfo
	MissingParameterException		missing cluResultId or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getCluResultByClu
Description	Retrieves the cluResult for a particular clu
Parameters	String	cluId	clu identifier
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	CluResultInfoList		result information for a clu
Errors	DoesNotExistException		cluId not found
	InvalidParameterException		invalid contextInfo
	MissingParameterException		missing cluId or contextInfo
	OperationFailedException		unable to complete request

Back to Operations

Method	getCluIdsByResultUsageType
Description	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	String	resultUsageTypeKey	identifier of the result usage type
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StringList		list of clu Ids
Errors	DoesNotExistException		resultUsageType not found
	InvalidParameterException		invalid resultUsageTypeKey
	MissingParameterException		missing resultUsageTypeKey
	OperationFailedException		unable to complete request

Back to Operations

Method	getCluIdsByResultComponent
Description	Retrieves the list of clu Ids which use a particular result component
Parameters	String	resultComponentId	identifier of the result component
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StringList		list of clu Ids
Errors	DoesNotExistException		resultComponent not found
	InvalidParameterException		invalid resultComponentId
	MissingParameterException		missing resultComponentId
	OperationFailedException		unable to complete request

Back to Operations

Method	getCluLoRelation
Description	Retrieve information on a CLU LO Relation.
Parameters	String	cluLoRelationId	Identifier of the CLU LO Relation
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	CluLoRelationInfo		The retrieved CLU LO Relation information
Errors	DoesNotExistException		cluLoRelationId not found
	InvalidParameterException		invalid contextInfo
	MissingParameterException		missing cluLoRelationId or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getCluLoRelationsByClu
Description	Retrieves the list of canonical learning unit to learning objective relationships for a given CLU.
Parameters	String	cluId	Identifier for the CLU
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	CluLoRelationInfoList		List of canonical learning unit to learning objective relationships
Errors	DoesNotExistException		cluId not found
	InvalidParameterException		invalid contextInfo
	MissingParameterException		missing cluId or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getCluLoRelationsByLo
Description	Retrieves the list of CLU identifiers associated with a given learning objective identifier.
Parameters	String	loId	Identifier for the learning objective
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	CluLoRelationInfoList		List of CLU LO Relations
Errors	DoesNotExistException		loId not found
	InvalidParameterException		invalid contextInfo
	MissingParameterException		missing loId or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getResourceRequirementsForClu
Description	Retrieves the list of Resource requirements for the specified CLU
Parameters	String	cluId	Unique identifier for the CLU
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StringList		List of resource requirements
Errors	DoesNotExistException		cluId not found
	InvalidParameterException		invalid contextInfo
	MissingParameterException		missing cluId or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getCluSet
Description	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	String	cluSetId	Identifier of the CLU set
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	CluSetInfo		The retrieved CLU set information
Errors	DoesNotExistException		cluSetId not found
	InvalidParameterException		invalid contextInfo
	MissingParameterException		missing cluSetId or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getCluSetTreeView
Description	Retrieve information on a CLU set and its sub clu set fully expanded.
Parameters	String	cluSetId	Identifier of the CLU set
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	CluSetTreeViewInfo		The retrieved CLU set tree view information
Errors	DoesNotExistException		cluSetId not found
	InvalidParameterException		invalid contextInfo
	MissingParameterException		missing cluSetId or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getCluSetsByIds
Description	Retrieve information on CLU sets from a list of cluSet Ids.
Parameters	StringList	cluSetIds	List of identifiers of CLU sets
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	CluSetInfoList		The retrieved list of CLU set information
Errors	DoesNotExistException		One or more cluSets not found
	InvalidParameterException		invalid contextInfo
	MissingParameterException		missing cluSetIds or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getCluSetIdsFromCluSet
Description	Retrieve the list of CLU Set Ids within a CLU Set
Parameters	String	cluSetId	Identifier of the CLU set
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StringList		The retrieved list of CLU Set Ids within the specified CLU set
Errors	DoesNotExistException		cluSet not found
	InvalidParameterException		invalid contextInfo
	MissingParameterException		missing cluSetId or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	isCluSetDynamic
Description	Check if the given CluSet is dynamic
Parameters	String	cluSetId	Identifier of the CLU set
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	Boolean		The retrieved list of CLU Set Ids within the specified CLU set
Errors	DoesNotExistException		cluSetId not found
	InvalidParameterException		invalid contextInfo
	MissingParameterException		missing cluSetId or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getClusFromCluSet
Description	Retrieves the list of CLUs in a CLU set. This only retrieves the direct members.
Parameters	String	cluSetId	Identifier of the CLU set
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	CluInfoList		The retrieved list of information on the CLUs within the CLU set (flattened and de-duped)
Errors	DoesNotExistException		cluSetId not found
	InvalidParameterException		invalid contextInfo
	MissingParameterException		missing cluSetId or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getCluIdsFromCluSet
Description	Retrieves the list of CLU Identifiers within a CLU Set. This only retrieves the direct members.
Parameters	String	cluSetId	Identifier of the CLU set
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StringList		The retrieved list of CLU Ids within the specified CLU set (flattened and de-duped)
Errors	DoesNotExistException		cluSetId not found
	InvalidParameterException		invalid contextInfo
	MissingParameterException		missing cluSetId or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getAllClusInCluSet
Description	Retrieves the full list of CLUs in this CLU set or any cluset that is included within that.
Parameters	String	cluSetId	Identifier of the CLU set
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	CluInfoList		The retrieved list of information on the CLUs
Errors	DoesNotExistException		cluSet not found
	InvalidParameterException		invalid contextInfo
	MissingParameterException		missing cluSetId or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getAllCluIdsInCluSet
Description	Retrieves the list of CLU Identifiers within a CLU Set or any cluset that is included within that.
Parameters	String	cluSetId	Identifier of the CLU set
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StringList		The retrieved list of CLU Ids within the specified CLU set
Errors	DoesNotExistException		cluSetId not found
	InvalidParameterException		invalid contextInfo
	MissingParameterException		missing cluSetId or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	isCluInCluSet
Description	Checks if a CLU is a member of a CLU set or any contained CLU set
Parameters	String	cluId	Identifier of the CLU to check
	String	cluSetId	Identifier of the CLU set
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	Boolean		True if the CLU is a member of the CLU Set
Errors	DoesNotExistException		cluId, cluSetId not found
	InvalidParameterException		invalid contextInfo
	MissingParameterException		missing cluId, cluSetId or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	validateClu
Description	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	String	validationTypeKey	identifier of the extent of validation
	CluInfo	cluInfo	CLU information to be tested.
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	ValidationResultInfoList		results from performing the validation
Errors	DoesNotExistException		validationTypeKey not found
	InvalidParameterException		invalid cluInfo or contextInfo
	MissingParameterException		missing validationTypeKey, cluInfo or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	createClu
Description	Creates a new CLU
Parameters	String	luTypeKey	identifier of the LU Type for the CLU being created
	CluInfo	cluInfo	information about the CLU being created
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	CluInfo		the created CLU information
Errors	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

Back to Operations

Method	updateClu
Description	Updates an existing CLU
Parameters	String	cluId	identifier for the CLU to be updated
	CluInfo	cluInfo	updated information about the CLU
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	CluInfo		the updated CLU information
Errors	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

Back to Operations

Method	deleteClu
Description	Deletes an existing CLU
Parameters	String	cluId	identifier for the CLU to be deleted
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StatusInfo		status of the operation
Errors	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

Back to Operations

Method	createNewCluVersion
Description	Creates a new CLU version based on the current clu
Parameters	String	cluId	identifier for the CLU to be versioned
	String	versionComment	comment for the current version
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	CluInfo		the new versioned CLU information
Errors	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

Back to Operations

Method	setCurrentCluVersion
Description	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	String	cluVersionId	Version Specific Id of the Clu
	Date	currentVersionStart	Date when this clu becomes current. Must be in the future and be after the most current clu's start date.
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StatusInfo		status of the operation
Errors	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

Back to Operations

Method	updateCluState
Description	Updates the state of the specified CLU
Parameters	String	cluId	identifier for the CLU to be updated
	String	luState	new state for the CLU. Value is expected to be constrained to those in the luState enumeration.
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	CluInfo		the updated CLU information
Errors	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

Back to Operations

Method	validateCluCluRelation
Description	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	String	validationTypeKey	identifier of the extent of validation
	String	cluId	identifier of the first CLU in the relationship - The From or Parent of the relation
	String	relatedCluId	identifier of the second CLU in the relationship to be related to - the To or Child of the Relation
	String	cluCluRelationTypeKey	the CLU to CLU relationship type of the relationship
	CluCluRelationInfo	cluCluRelationInfo	cluCluRelation information to be tested.
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	ValidationResultInfoList		results from performing the validation
Errors	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

Back to Operations

Method	createCluCluRelation
Description	Create a directional relationship between two CLUs
Parameters	String	cluId	identifier of the first CLU in the relationship - The From or Parent of the relation
	String	relatedCluId	identifier of the second CLU in the relationship to be related to - the To or Child of the Relation
	String	cluCluRelationTypeKey	the LU to LU relationship type of the relationship
	CluCluRelationInfo	cluCluRelationInfo	information about the relationship between the two CLUs
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	CluCluRelationInfo		the created CLU to CLU relation information
Errors	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

Back to Operations

Method	updateCluCluRelation
Description	Updates a relationship between two CLUs
Parameters	String	cluCluRelationId	identifier of the CLU to CLU relation to be updated
	CluCluRelationInfo	cluCluRelationInfo	changed information about the CLU to CLU relationship
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	CluCluRelationInfo		the updated CLU to CLU relation information
Errors	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

Back to Operations

Method	deleteCluCluRelation
Description	Deletes a relationship between two CLUs
Parameters	String	cluCluRelationId	identifier of CLU to CLU relationship to delete
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StatusInfo		status of the operation (success or failure)
Errors	DoesNotExistException		cluCluRelationId not found
	InvalidParameterException		invalid contextInfo
	MissingParameterException		missing cluCluRelationId or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	validateCluPublication
Description	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	String	validationTypeKey	identifier of the extent of validation
	String	cluId	identifier of a clu
	String	luPublicationTypeKey	type of lu publication
	CluPublicationInfo	cluPublicationInfo	CLU publication information to be tested.
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	ValidationResultInfoList		results from performing the validation
Errors	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

Back to Operations

Method	createCluPublication
Description	Create a clu publication object, which contains information about publication for a clu.
Parameters	String	cluId	identifier of a clu
	String	luPublicationTypeKey	type of lu publication
	CluPublicationInfo	cluPublicationInfo	information about publication for a clu
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	CluPublicationInfo		information about the created clu publication object
Errors	DataValidationErrorException		supplied data is invalid
	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

Back to Operations

Method	updateCluPublication
Description	Updates an existing clu publication object
Parameters	String	cluPublicationId	identifier for the clu publication object to be updated
	CluPublicationInfo	cluPublicationInfo	updated information about the clu publication object
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	CluPublicationInfo		the updated clu publication information
Errors	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.

Back to Operations

Method	deleteCluPublication
Description	Deletes an existing clu publication object
Parameters	String	cluPublicationId	identifier for the clu publication object to be deleted
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StatusInfo		status of the operation
Errors	DoesNotExistException		cluPublicationId not found
	InvalidParameterException		invalid contextInfo
	MissingParameterException		missing cluPublicationId or contextInfo
	DependentObjectsExistException		delete would leave orphaned objects or violate integrity constraints
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	validateCluResult
Description	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	String	validationTypeKey	identifier of the extent of validation
	String	cluId	identifier of a clu
	String	cluResultTypeKey	type of clu result
	CluResultInfo	cluResultInfo	CLU result information to be tested.
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	ValidationResultInfoList		results from performing the validation
Errors	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

Back to Operations

Method	createCluResult
Description	Create a clu result object, which contains information about potential results for a clu.
Parameters	String	cluId	identifier of a clu
	String	cluResultTypeKey	type of clu result
	CluResultInfo	cluResultInfo	information about potential results for a clu
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	CluResultInfo		information about the created clu result
Errors	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

Back to Operations

Method	updateCluResult
Description	Updates an existing clu result
Parameters	String	cluResultId	identifier for the clu result to be updated
	CluResultInfo	cluResultInfo	updated information about the clu result
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	CluResultInfo		the updated clu result information
Errors	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

Back to Operations

Method	deleteCluResult
Description	Deletes an existing clu result
Parameters	String	cluResultId	identifier for the clu result to be deleted
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StatusInfo		status of the operation
Errors	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

Back to Operations

Method	validateCluLoRelation
Description	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	String	validationTypeKey	identifier of the extent of validation
	String	cluId	CLU identifier
	String	loId	learning objective identifier
	String	cluLoRelationTypeKey	type of clu learning objective relationship
	CluLoRelationInfo	cluLoRelationInfo	cluLoRelation information to be tested.
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	ValidationResultInfoList		results from performing the validation
Errors	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

Back to Operations

Method	createCluLoRelation
Description	Creates a relationship between a learning objective and a CLU.
Parameters	String	cluId	CLU identifier
	String	loId	learning objective identifier
	String	cluLoRelationTypeKey	type of clu learning objective relationship
	CluLoRelationInfo	cluLoRelationInfo	clu learning objective relationship information
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	CluLoRelationInfo		the newly created clu learning objective relationship
Errors	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

Back to Operations

Method	updateCluLoRelation
Description	Updates a relationship between a clu and learning objective
Parameters	String	cluLoRelationId	identifier of the clu learning objective relationship to be updated
	CluLoRelationInfo	cluLoRelationInfo	information about the clu learning objective relationship to be updated
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	CluLoRelationInfo		the updated clu learning objective relationship information
Errors	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.

Back to Operations

Method	deleteCluLoRelation
Description	Removes a relationship between a learning objective and a Clu.
Parameters	String	cluLoRelationId	CLU learning objective Relationship identifier
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StatusInfo		Status of the delete operation
Errors	DoesNotExistException		cluLoRelationId not found
	InvalidParameterException		invalid contextInfo
	MissingParameterException		missing cluLoRelationId
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	addCluResourceRequirement
Description	Add a Resource requirement to a CLU
Parameters	String	resourceTypeKey	identifier of the resource requirement type to be added to the CLU
	String	cluId	identifier of the CLU
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StatusInfo		status of the operation (success or failure)
Errors	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

Back to Operations

Method	removeCluResourceRequirement
Description	Remove a Resource requirement from a CLU
Parameters	String	resourceTypeKey	identifier of the resource type to be removed from the CLU
	String	cluId	identifier of the CLU
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StatusInfo		status of the operation (success or failure)
Errors	DoesNotExistException		resourceTypeKey or cluId not found
	InvalidParameterException		invalid contextInfo
	MissingParameterException		missing resourceTypeKey, cluId or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	validateCluSet
Description	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	String	validationTypeKey	identifier of the extent of validation
	String	cluSetTypeKey	type of the CLU set to be created
	CluSetInfo	cluSetInfo	CLU set information to be tested.
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	ValidationResultInfoList		results from performing the validation
Errors	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

Back to Operations

Method	createCluSet
Description	Creates a CLU set.
Parameters	String	cluSetTypeKey	type of the CLU set to be created
	CluSetInfo	cluSetInfo	information required to create a CLU set
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	CluSetInfo		the created CLU set information
Errors	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

Back to Operations

Method	updateCluSet
Description	Update the information for a CLU set
Parameters	String	cluSetId	identifier of the CLU set to be updated
	CluSetInfo	cluSetInfo	updated information about the CLU set
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	CluSetInfo		the updated CLU set information
Errors	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

Back to Operations

Method	deleteCluSet
Description	Delete a CLU set
Parameters	String	cluSetId	identifier of the CLU set to be deleted
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StatusInfo		status of the operation (success or failure)
Errors	DoesNotExistException		cluSetId not found
	InvalidParameterException		invalid contextInfo
	MissingParameterException		missing cluSetId or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	addCluSetToCluSet
Description	Adds one CLU set to another
Parameters	String	cluSetId	identifier of the host CLU set
	String	addedCluSetId	identifier of the CLU set to be added
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StatusInfo		status of the operation (success or failure)
Errors	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

Back to Operations

Method	addCluSetsToCluSet
Description	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	String	cluSetId	identifier of the host CLU set
	StringList	addedCluSetIds	list of identifiers of the CLU sets to be added
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StatusInfo		status of the operation (success or failure)
Errors	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

Back to Operations

Method	removeCluSetFromCluSet
Description	Removes one CLU set from another
Parameters	String	cluSetId	identifier of the host CLU set
	String	removedCluSetId	identifier of the CLU set to be removed
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StatusInfo		status of the operation (success or failure)
Errors	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

Back to Operations

Method	addCluToCluSet
Description	Add a CLU to a CLU set
Parameters	String	cluId	identifier of CLU to add to the CLU set
	String	cluSetId	identifier of the CLU set
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StatusInfo		status of the operation (success or failure)
Errors	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

Back to Operations

Method	addClusToCluSet
Description	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	StringList	cluSetIds	list of identifiers of CLUs to add to the CLU set
	String	cluSetId	identifier of the CLU set to be added
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StatusInfo		status of the operation (success or failure)
Errors	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

Back to Operations

Method	removeCluFromCluSet
Description	Remove a CLU from a CLU set
Parameters	String	cluId	identifier of CLU to remove from the CLU set
	String	cluSetId	identifier of the CLU set
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StatusInfo		status of the operation (success or failure)
Errors	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

Back to Operations

Method	search
Description	???
Parameters	SearchRequest	request	???
Return	SearchResult		???
Errors	MissingParameterException		???

Back to Operations

Method	getSearchCriteriaType
Description	This method ... ============== Deprecated ===============
Parameters	String	searchCriteriaTypeKey	???
Return	SearchCriteriaTypeInfo		???
Errors	DoesNotExistException		???
	InvalidParameterException		???
	MissingParameterException		???
	OperationFailedException		???
	UnsupportedOperationException		???

Back to Operations

Method	getSearchCriteriaTypes
Description	This method ... ============== Deprecated ===============
Parameters	None	None	No Parameters
Return	SearchCriteriaTypeInfoList		???
Errors	OperationFailedException		???
	UnsupportedOperationException		???

Back to Operations

Method	getSearchResultType
Description	This method ... ============== Deprecated ===============
Parameters	String	searchResultTypeKey	???
Return	SearchResultTypeInfo		???
Errors	DoesNotExistException		???
	InvalidParameterException		???
	MissingParameterException		???
	OperationFailedException		???
	UnsupportedOperationException		???

Back to Operations

Method	getSearchResultTypes
Description	This method ... ============== Deprecated ===============
Parameters	None	None	No Parameters
Return	SearchResultTypeInfoList		???
Errors	OperationFailedException		???
	UnsupportedOperationException		???

Back to Operations

Method	getSearchType
Description	This method ... ============== Deprecated ===============
Parameters	String	searchTypeKey	???
Return	SearchTypeInfo		???
Errors	DoesNotExistException		???
	InvalidParameterException		???
	MissingParameterException		???
	OperationFailedException		???
	UnsupportedOperationException		???

Back to Operations

Method	getSearchTypes
Description	This method ... ============== Deprecated ===============
Parameters	None	None	No Parameters
Return	SearchTypeInfoList		???
Errors	OperationFailedException		???
	UnsupportedOperationException		???

Back to Operations

Method	getSearchTypesByCriteria
Description	This method ... ============== Deprecated ===============
Parameters	String	searchCriteriaTypeKey	???
Return	SearchTypeInfoList		???
Errors	DoesNotExistException		???
	InvalidParameterException		???
	MissingParameterException		???
	OperationFailedException		???
	UnsupportedOperationException		???

Back to Operations

Method	getSearchTypesByResult
Description	This method ... ============== Deprecated ===============
Parameters	String	searchResultTypeKey	???
Return	SearchTypeInfoList		???
Errors	DoesNotExistException		???
	InvalidParameterException		???
	MissingParameterException		???
	OperationFailedException		???
	UnsupportedOperationException		???

Back to Operations