@Transactional(readOnly=true, noRollbackFor=DoesNotExistException.class, rollbackFor=java.lang.Throwable.class) public class CluServiceImpl extends Object implements CluService
Modifier and Type | Class and Description |
---|---|
class |
CluServiceImpl.SearchResultRowComparator |
Constructor and Description |
---|
CluServiceImpl() |
Modifier and Type | Method and Description |
---|---|
StatusInfo |
addCluResourceRequirement(String resourceTypeKey,
String cluId,
ContextInfo context)
Add a Resource requirement to a CLU
|
StatusInfo |
addCluSetsToCluSet(String cluSetId,
List<String> cluSetIds,
ContextInfo context)
Adds a list of CLU sets to another CluSet.
|
StatusInfo |
addCluSetToCluSet(String cluSetId,
String addedCluSetId,
ContextInfo context)
Adds one CLU set to another
|
StatusInfo |
addClusToCluSet(List<String> cluIds,
String cluSetId,
ContextInfo context)
Adds a list of CLUs to a CLU set.
|
StatusInfo |
addCluToCluSet(String cluId,
String cluSetId,
ContextInfo context)
Add a CLU to a CLU set
|
CluInfo |
createClu(String luTypeKey,
CluInfo cluInfo,
ContextInfo context)
Creates a new CLU
|
CluCluRelationInfo |
createCluCluRelation(String cluId,
String relatedCluId,
String luLuRelationTypeKey,
CluCluRelationInfo cluCluRelationInfo,
ContextInfo context)
Create a directional relationship between two CLUs
|
CluLoRelationInfo |
createCluLoRelation(String cluId,
String loId,
String cluLoRelationType,
CluLoRelationInfo cluLoRelationInfo,
ContextInfo context)
Creates a relationship between a learning objective and a CLU.
|
CluPublicationInfo |
createCluPublication(String cluId,
String luPublicationType,
CluPublicationInfo cluPublicationInfo,
ContextInfo context)
Create a clu publication object, which contains information about
publication for a clu.
|
CluResultInfo |
createCluResult(String cluId,
String cluResultTypeKey,
CluResultInfo cluResultInfo,
ContextInfo context)
Create a clu result object, which contains information about potential
results for a clu.
|
CluSetInfo |
createCluSet(String cluSetType,
CluSetInfo cluSetInfo,
ContextInfo contextInfo)
Creates a CLU set.
|
CluInfo |
createNewCluVersion(String versionIndCluId,
String versionComment,
ContextInfo context)
Versioning Methods
|
StatusInfo |
deleteClu(String cluId,
ContextInfo context)
Deletes an existing CLU
|
StatusInfo |
deleteCluCluRelation(String cluCluRelationId,
ContextInfo context)
Deletes a relationship between two CLUs
|
StatusInfo |
deleteCluLoRelation(String cluLoRelationId,
ContextInfo context)
Removes a relationship between a learning objective and a Clu.
|
StatusInfo |
deleteCluPublication(String cluPublicationId,
ContextInfo context)
Deletes an existing clu publication object
|
StatusInfo |
deleteCluResult(String cluResultId,
ContextInfo context)
Deletes an existing clu result
|
StatusInfo |
deleteCluSet(String cluSetId,
ContextInfo context)
Delete a CLU set
|
List<String> |
getAllCluIdsInCluSet(String cluSetId,
ContextInfo context)
Retrieves the list of CLU Identifiers within a CLU Set or any cluset that
is included within that.
|
List<CluInfo> |
getAllClusInCluSet(String cluSetId,
ContextInfo context)
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 context)
Retrieves the list of allowed relation types between the two specified
CLUs
|
List<String> |
getAllowedCluLoRelationTypesForLuType(String luTypeKey,
ContextInfo context)
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 context)
Retrieves the list of allowed relation types between the two specified LU
Types
|
List<String> |
getAllowedResultComponentTypesForResultUsageType(String resultUsageTypeKey,
ContextInfo context)
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 context)
Retrieves the list of result usage types which are allowed to be used in
conjunction with an lu type.
|
CluInfo |
getClu(String cluId,
ContextInfo context)
READ OPERATION *
|
CluCluRelationInfo |
getCluCluRelation(String cluCluRelationId,
ContextInfo context)
Retrieves the relationship information between CLUs for a particular
Relation instance
|
List<CluCluRelationInfo> |
getCluCluRelationsByClu(String cluId,
ContextInfo context)
Retrieves the list of relationship information for the specified CLU
|
List<TypeInfo> |
getCluCluRelationTypes(ContextInfo context)
Retrieves the complete list of LU to LU relation types
|
CriteriaLookupService |
getCluCriteriaLookupService() |
List<String> |
getCluIdsByLuType(String luTypeKey,
String luState,
ContextInfo context)
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 context)
Retrieves the list of clu Ids which use a particular result component
|
List<String> |
getCluIdsByResultUsageType(String resultUsageTypeKey,
ContextInfo context)
Retrieves the list of clu Ids with the results of the specified usage
type.
|
List<String> |
getCluIdsFromCluSet(String cluSetId,
ContextInfo context)
Retrieves the list of CLU Identifiers within a CLU Set.
|
CluLoRelationInfo |
getCluLoRelation(String cluLoRelationId,
ContextInfo context)
Retrieve information on a CLU LO Relation.
|
List<CluLoRelationInfo> |
getCluLoRelationsByClu(String cluId,
ContextInfo context)
Retrieves the list of canonical learning unit to learning objective
relationships for a given CLU.
|
List<CluLoRelationInfo> |
getCluLoRelationsByLo(String loId,
ContextInfo context)
Retrieves the list of CLU identifiers associated with a given learning
objective identifier.
|
TypeInfo |
getCluLoRelationType(String cluLoRelationTypeKey,
ContextInfo context)
Retrieves information for a specified CLU to LO relation type
|
List<TypeInfo> |
getCluLoRelationTypes(ContextInfo context)
Retrieves the complete list of CLU to LO relation types
|
CluPublicationInfo |
getCluPublication(String cluPublicationId,
ContextInfo context)
Retrieves an LU publication object by its identifier
|
List<CluPublicationInfo> |
getCluPublicationsByClu(String cluId,
ContextInfo context)
Retrieves a list of publication objects for a particular clu
|
List<CluPublicationInfo> |
getCluPublicationsByType(String luPublicationTypeKey,
ContextInfo context)
Retrieves a list of publication objects of a particular Type
|
CluResultInfo |
getCluResult(String cluResultId,
ContextInfo context)
Retrieves information about a Clu Result
|
List<CluResultInfo> |
getCluResultByClu(String cluId,
ContextInfo context)
Retrieves the cluResult for a particular clu
|
List<CluResultInfo> |
getCluResultsByClus(List<String> cluIds,
ContextInfo contextInfo)
Retrieves the list of cluResults for the cluIds specified
|
TypeInfo |
getCluResultType(String cluResultTypeKey,
ContextInfo context)
Retrieves information about a publication type
|
List<TypeInfo> |
getCluResultTypes(ContextInfo context)
Retrieves a list of types for clu result objects.
|
List<TypeInfo> |
getCluResultTypesForLuType(String luTypeKey,
ContextInfo context)
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 context)
Retrieves information about CLUs from a list of Ids
|
List<CluInfo> |
getClusByLuType(String luTypeKey,
String luState,
ContextInfo context)
Retrieves the list of CLUs for the specified LU Type and state
|
List<CluInfo> |
getClusByRelatedCluAndRelationType(String relatedCluId,
String luLuRelationTypeKey,
ContextInfo context)
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 context)
Retrieve the list of CLU Set Ids within a CLU Set
|
List<CluSetInfo> |
getCluSetsByIds(List<String> cluSetIds,
ContextInfo context)
Retrieve information on CLU sets from a list of cluSet Ids.
|
CluSetTreeViewInfo |
getCluSetTreeView(String cluSetId,
ContextInfo context)
Retrieve information on a CLU set and its sub clu set fully expanded.
|
TypeInfo |
getCluSetType(String cluSetTypeKey,
ContextInfo context)
Retrieves information about a specified CLU set type
|
List<TypeInfo> |
getCluSetTypes(ContextInfo context)
Retrieves the list of CLU set types known by the service
|
List<CluInfo> |
getClusFromCluSet(String cluSetId,
ContextInfo context)
Retrieves the list of CLUs in a CLU set.
|
VersionDisplayInfo |
getCurrentVersion(String refObjectTypeURI,
String refObjectId,
ContextInfo context)
Retrieves current version associated with the objectId.
|
VersionDisplayInfo |
getCurrentVersionOnDate(String refObjectTypeURI,
String refObjectId,
Date date,
ContextInfo context)
Retrieves the current version associated with the objectId on a given
date.
|
TypeInfo |
getDeliveryMethodType(String deliveryMethodTypeKey,
ContextInfo context)
Retrieves information about a delivery method type
|
List<TypeInfo> |
getDeliveryMethodTypes(ContextInfo context)
SETUP OPERATION *
|
DictionaryService |
getDictionaryServiceDelegate() |
VersionDisplayInfo |
getFirstVersion(String refObjectTypeURI,
String refObjectId,
ContextInfo context)
Retrieves first version associated with the objectId.
|
TypeInfo |
getInstructionalFormatType(String instructionalFormatTypeKey,
ContextInfo context)
Retrieves information about a Instructional Format Type
|
List<TypeInfo> |
getInstructionalFormatTypes(ContextInfo context)
Retrieves the list of instructional format types
|
VersionDisplayInfo |
getLatestVersion(String refObjectTypeURI,
String refObjectId,
ContextInfo context)
Retrieves latest version associated with the objectId.
|
TypeInfo |
getLuCodeType(String luCodeTypeKey,
ContextInfo context)
Retrieves information about a learning unit code type
|
List<TypeInfo> |
getLuCodeTypes(ContextInfo context)
Retrieves the list of learning unit code types
|
LuDao |
getLuDao() |
TypeInfo |
getLuLuRelationType(String luLuRelationTypeKey,
ContextInfo context)
Retrieves the LU to LU relation type
|
TypeInfo |
getLuPublicationType(String luPublicationTypeKey,
ContextInfo context)
Retrieves information about a publication type
|
List<TypeInfo> |
getLuPublicationTypes(ContextInfo context)
Retrieves the list of Learning Unit publication types
|
List<String> |
getLuPublicationTypesForLuType(String luTypeKey,
ContextInfo context)
Retrieves information about a publication type
|
TypeInfo |
getLuType(String luTypeKey,
ContextInfo context)
Retrieves information about a LU Type
|
List<TypeInfo> |
getLuTypes(ContextInfo context)
Retrieves the list of LU types
|
List<String> |
getRelatedCluIdsByCluAndRelationType(String cluId,
String luLuRelationTypeKey,
ContextInfo context)
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 relatedCluId,
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 context)
Retrieves the list of Resource requirements for the specified CLU
|
TypeInfo |
getResultUsageType(String resultUsageTypeKey,
ContextInfo context)
Retrieves information about a Result Usage Type
|
List<TypeInfo> |
getResultUsageTypes(ContextInfo context)
Retrieves a list of result usage types
|
SearchManager |
getSearchManager() |
TypeInfo |
getSearchType(String searchTypeKey,
ContextInfo contextInfo)
Retrieves information about a particular search type.
|
List<TypeInfo> |
getSearchTypes(ContextInfo contextInfo)
Retrieves the list of search types known by this service.
|
ValidatorFactory |
getValidatorFactory() |
VersionDisplayInfo |
getVersionBySequenceNumber(String refObjectTypeURI,
String refObjectId,
Long sequence,
ContextInfo context)
Retrieves the version associated with the objectId and the sequence
number.
|
List<VersionDisplayInfo> |
getVersions(String refObjectTypeURI,
String refObjectId,
ContextInfo context)
Retrieves a list of versions associated with the objectId.
|
List<VersionDisplayInfo> |
getVersionsInDateRange(String refObjectTypeURI,
String refObjectId,
Date from,
Date to,
ContextInfo context)
Retrieves the current version associated with the objectId in a given
date range
|
Boolean |
isCluInCluSet(String cluId,
String cluSetId,
ContextInfo context)
Checks if a CLU is a member of a CLU set or any contained CLU set
|
Boolean |
isCluSetDynamic(String cluSetId,
ContextInfo context)
Check if the given CluSet is dynamic
|
StatusInfo |
removeCluFromCluSet(String cluId,
String cluSetId,
ContextInfo context)
Remove a CLU from a CLU set
|
StatusInfo |
removeCluResourceRequirement(String resourceTypeKey,
String cluId,
ContextInfo context)
Remove a Resource requirement from a CLU
|
StatusInfo |
removeCluSetFromCluSet(String cluSetId,
String removedCluSetId,
ContextInfo context)
Removes one CLU set from another
|
SearchResultInfo |
search(SearchRequestInfo searchRequest,
ContextInfo contextInfo)
Performs a search.
|
List<String> |
searchForCluCluRelationIds(QueryByCriteria criteria,
ContextInfo contextInfo)
Search for CluCluRelation Ids using free form search criteria
|
List<CluCluRelationInfo> |
searchForCluCluRelations(QueryByCriteria criteria,
ContextInfo contextInfo)
Search for CluCluRelations using free form search criteria
|
List<String> |
searchForCluIds(QueryByCriteria criteria,
ContextInfo contextInfo)
Search for Clu Ids using free form search criteria
|
List<String> |
searchForCluLoRelationIds(QueryByCriteria criteria,
ContextInfo contextInfo)
Search for CluLoRelation Ids using free form search criteria
|
List<CluLoRelationInfo> |
searchForCluLoRelations(QueryByCriteria criteria,
ContextInfo contextInfo)
Search for CluLoRelations using free form search criteria.
|
List<String> |
searchForCluPublicationIds(QueryByCriteria criteria,
ContextInfo contextInfo)
Search for CluPublication Ids using free form search criteria
|
List<CluPublicationInfo> |
searchForCluPublications(QueryByCriteria criteria,
ContextInfo contextInfo)
Search for CluPublications using free form search criteria
|
List<String> |
searchForCluResultIds(QueryByCriteria criteria,
ContextInfo contextInfo)
Search for CluResult Ids using free form search criteria
|
List<CluResultInfo> |
searchForCluResults(QueryByCriteria criteria,
ContextInfo contextInfo)
Search for CluResults using free form search criteria
|
List<CluInfo> |
searchForClus(QueryByCriteria criteria,
ContextInfo contextInfo)
Search for Clus using free form search criteria.
|
void |
setCluCriteriaLookupService(CriteriaLookupService cluCriteriaLookupService) |
StatusInfo |
setCurrentCluVersion(String cluVersionId,
Date currentVersionStart,
ContextInfo context)
This method sets the CLU with ID of cluVersionId as the current version and will set the version end date of the previously current version to currentVersionStart or now() if null.
|
void |
setDictionaryServiceDelegate(DictionaryService dictionaryServiceDelegate) |
void |
setLuDao(LuDao luDao) |
void |
setSearchDispatcher(SearchService searchDispatcher) |
void |
setSearchManager(SearchManager searchManager) |
void |
setValidatorFactory(ValidatorFactory validatorFactory) |
Clu |
toCluForCreate(String luTypeKey,
CluInfo cluInfo,
ContextInfo context) |
CluInfo |
updateClu(String cluId,
CluInfo cluInfo,
ContextInfo context)
Updates an existing CLU
|
CluCluRelationInfo |
updateCluCluRelation(String cluCluRelationId,
CluCluRelationInfo cluCluRelationInfo,
ContextInfo context)
Updates a relationship between two CLUs
|
CluLoRelationInfo |
updateCluLoRelation(String cluLoRelationId,
CluLoRelationInfo cluLoRelationInfo,
ContextInfo context)
Updates a relationship between a clu and learning objective
|
CluPublicationInfo |
updateCluPublication(String cluPublicationId,
CluPublicationInfo cluPublicationInfo,
ContextInfo context)
Updates an existing clu publication object
|
CluResultInfo |
updateCluResult(String cluResultId,
CluResultInfo cluResultInfo,
ContextInfo context)
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 context)
Updates the state of the specified CLU
|
List<ValidationResultInfo> |
validateClu(String validationType,
CluInfo cluInfo,
ContextInfo context)
MAINTENANCE OPERATIONS *
|
List<ValidationResultInfo> |
validateCluCluRelation(String validationTypeKey,
String cluId,
String relatedCluId,
String cluCluRelationTypeKey,
CluCluRelationInfo cluCluRelationInfo,
ContextInfo contextInfo)
Validates a cluCluRelation.
|
List<ValidationResultInfo> |
validateCluLoRelation(String validationType,
String cluId,
String loId,
String cluLoRelationType,
CluLoRelationInfo cluLoRelationInfo,
ContextInfo context)
Validates a cluLoRelation.
|
List<ValidationResultInfo> |
validateCluPublication(String validationType,
String cluId,
String luPublicationTypeKey,
CluPublicationInfo cluPublicationInfo,
ContextInfo context)
Validates information about publication for a clu.
|
List<ValidationResultInfo> |
validateCluResult(String validationType,
String cluId,
String cluResultTypeKey,
CluResultInfo cluResultInfo,
ContextInfo context)
Validates information about results for a clu.
|
List<ValidationResultInfo> |
validateCluSet(String validationType,
String cluSetType,
CluSetInfo cluSetInfo,
ContextInfo context)
Validates information about a clu set.
|
public CluServiceImpl()
public void setDictionaryServiceDelegate(DictionaryService dictionaryServiceDelegate)
public DictionaryService getDictionaryServiceDelegate()
public List<TypeInfo> getSearchTypes(ContextInfo contextInfo) throws InvalidParameterException, MissingParameterException, OperationFailedException
SearchService
getSearchTypes
in interface SearchService
contextInfo
- information containing the principalId and locale
information about the caller of service operationInvalidParameterException
- contextInfo is not validMissingParameterException
- contextInfo is missing or nullOperationFailedException
- unable to complete requestpublic TypeInfo getSearchType(String searchTypeKey, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException
SearchService
getSearchType
in interface SearchService
searchTypeKey
- identifier of the search typecontextInfo
- information containing the principalId and locale
information about the caller of service operationDoesNotExistException
- specified searchTypeKey not foundInvalidParameterException
- contextInfo is not validMissingParameterException
- searchTypeKey or contextInfo is missing
or nullOperationFailedException
- unable to complete requestpublic SearchManager getSearchManager()
public void setSearchManager(SearchManager searchManager)
public CriteriaLookupService getCluCriteriaLookupService()
public void setCluCriteriaLookupService(CriteriaLookupService cluCriteriaLookupService)
public List<TypeInfo> getDeliveryMethodTypes(ContextInfo context) throws OperationFailedException
getDeliveryMethodTypes
in interface CluService
context
- Context information containing the principalId and
locale information about the caller of service
operationOperationFailedException
- unable to complete requestpublic TypeInfo getDeliveryMethodType(String deliveryMethodTypeKey, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException
CluService
getDeliveryMethodType
in interface CluService
deliveryMethodTypeKey
- Key of the Delivery Method Typecontext
- 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 requestpublic List<TypeInfo> getInstructionalFormatTypes(ContextInfo context) throws OperationFailedException
CluService
getInstructionalFormatTypes
in interface CluService
context
- Context information containing the principalId and
locale information about the caller of service
operationOperationFailedException
- unable to complete requestpublic TypeInfo getInstructionalFormatType(String instructionalFormatTypeKey, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException
CluService
getInstructionalFormatType
in interface CluService
instructionalFormatTypeKey
- Key of the Instructional Format Typecontext
- 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 requestpublic List<TypeInfo> getLuTypes(ContextInfo context) throws OperationFailedException
CluService
getLuTypes
in interface CluService
context
- Context information containing the principalId and
locale information about the caller of service
operationOperationFailedException
- unable to complete requestpublic TypeInfo getLuType(String luTypeKey, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException
CluService
getLuType
in interface CluService
luTypeKey
- Key of the LU Typecontext
- 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 requestpublic TypeInfo getLuCodeType(String luCodeTypeKey, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException
CluService
getLuCodeType
in interface CluService
luCodeTypeKey
- Key of the learning unit code typecontext
- 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 requestpublic List<TypeInfo> getLuCodeTypes(ContextInfo context) throws OperationFailedException
CluService
getLuCodeTypes
in interface CluService
context
- Context information containing the principalId and
locale information about the caller of service
operationOperationFailedException
- unable to complete requestpublic List<TypeInfo> getCluCluRelationTypes(ContextInfo context) throws OperationFailedException
CluService
getCluCluRelationTypes
in interface CluService
context
- Context information containing the principalId and
locale information about the caller of service
operationOperationFailedException
- unable to complete requestpublic TypeInfo getLuLuRelationType(String luLuRelationTypeKey, ContextInfo context) throws OperationFailedException, MissingParameterException, DoesNotExistException
CluService
getLuLuRelationType
in interface CluService
luLuRelationTypeKey
- Key of the LU to LU Relation Typecontext
- Context information containing the
principalId and locale information about the
caller of service operationOperationFailedException
- unable to complete requestMissingParameterException
- missing cluCluRelationTypeKey or
contextInfoDoesNotExistException
- cluCluRelationTypeKey not foundpublic List<String> getAllowedLuLuRelationTypesForLuType(String luTypeKey, String relatedLuTypeKey, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException
CluService
getAllowedLuLuRelationTypesForLuType
in interface CluService
luTypeKey
- Key of the first LU TyperelatedLuTypeKey
- Key of the second LU Typecontext
- 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 requestpublic List<TypeInfo> getLuPublicationTypes(ContextInfo context) throws OperationFailedException
CluService
getLuPublicationTypes
in interface CluService
context
- Context information containing the principalId and
locale information about the caller of service
operationOperationFailedException
- unable to complete requestpublic TypeInfo getLuPublicationType(String luPublicationTypeKey, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException
CluService
getLuPublicationType
in interface CluService
luPublicationTypeKey
- Key of the Learning Unit Publication Typecontext
- 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 requestpublic List<String> getLuPublicationTypesForLuType(String luTypeKey, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException
CluService
getLuPublicationTypesForLuType
in interface CluService
luTypeKey
- Key of the LU Typecontext
- 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 requestpublic List<TypeInfo> getCluResultTypes(ContextInfo context) throws OperationFailedException
CluService
getCluResultTypes
in interface CluService
context
- Context information containing the principalId and
locale information about the caller of service
operationOperationFailedException
- unable to complete requestpublic TypeInfo getCluResultType(String cluResultTypeKey, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException
CluService
getCluResultType
in interface CluService
cluResultTypeKey
- Key of the Canonical Learning Unit Result Typecontext
- 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 requestpublic List<TypeInfo> getCluResultTypesForLuType(String luTypeKey, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException
CluService
getCluResultTypesForLuType
in interface CluService
luTypeKey
- luTypeKeycontext
- 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 requestpublic List<TypeInfo> getResultUsageTypes(ContextInfo context) throws OperationFailedException
CluService
getResultUsageTypes
in interface CluService
context
- Context information containing the principalId and
locale information about the caller of service
operationOperationFailedException
- unable to complete requestpublic TypeInfo getResultUsageType(String resultUsageTypeKey, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException
CluService
getResultUsageType
in interface CluService
resultUsageTypeKey
- Key of the Result Usage Typecontext
- 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 requestpublic List<String> getAllowedResultUsageTypesForLuType(String luTypeKey, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException
CluService
getAllowedResultUsageTypesForLuType
in interface CluService
luTypeKey
- luTypeKeycontext
- 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 requestpublic List<String> getAllowedResultComponentTypesForResultUsageType(String resultUsageTypeKey, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException
CluService
getAllowedResultComponentTypesForResultUsageType
in interface CluService
resultUsageTypeKey
- resultUsageTypeKeycontext
- 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 requestpublic TypeInfo getCluLoRelationType(String cluLoRelationTypeKey, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException
CluService
getCluLoRelationType
in interface CluService
cluLoRelationTypeKey
- Key of the CLU to LO Relation Typecontext
- 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 requestpublic List<TypeInfo> getCluLoRelationTypes(ContextInfo context) throws OperationFailedException
CluService
getCluLoRelationTypes
in interface CluService
context
- Context information containing the principalId and
locale information about the caller of service
operationOperationFailedException
- unable to complete requestpublic List<String> getAllowedCluLoRelationTypesForLuType(String luTypeKey, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException
CluService
getAllowedCluLoRelationTypesForLuType
in interface CluService
luTypeKey
- luTypeKeycontext
- 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 requestpublic List<TypeInfo> getCluSetTypes(ContextInfo context) throws OperationFailedException
CluService
getCluSetTypes
in interface CluService
context
- Context information containing the principalId and
locale information about the caller of service
operationOperationFailedException
- unable to complete requestpublic TypeInfo getCluSetType(String cluSetTypeKey, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException
CluService
getCluSetType
in interface CluService
cluSetTypeKey
- Key of the CLU set typecontext
- 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 requestpublic CluInfo getClu(String cluId, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException
getClu
in interface CluService
cluId
- identifier of the CLUcontext
- 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 requestpublic List<CluInfo> getClusByIds(List<String> cluIds, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException
CluService
getClusByIds
in interface CluService
cluIds
- List of CLU identifierscontext
- 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 requestpublic List<CluInfo> getClusByLuType(String luTypeKey, String luState, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException
CluService
getClusByLuType
in interface CluService
luTypeKey
- Type of the CLUs to retrieveluState
- State of the CLUs to retrieve.context
- 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 requestpublic List<String> getCluIdsByLuType(String luTypeKey, String luState, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException
CluService
getCluIdsByLuType
in interface CluService
luTypeKey
- Type of the CLUs whose identifiers should be
retrievedluState
- State of the CLUs whose identifiers should be
retrievedcontext
- 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 requestpublic List<String> getAllowedCluCluRelationTypesByClu(String cluId, String relatedCluId, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException
CluService
getAllowedCluCluRelationTypesByClu
in interface CluService
cluId
- identifier of the first CLUrelatedCluId
- identifier of the second CLUcontext
- 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 requestpublic List<CluInfo> getClusByRelatedCluAndRelationType(String relatedCluId, String luLuRelationTypeKey, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException
CluService
getClusByRelatedCluAndRelationType
in interface CluService
relatedCluId
- identifier of the child or To CLUluLuRelationTypeKey
- the LU to LU relation typecontext
- 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 requestpublic List<String> getCluIdsByRelatedCluAndRelationType(String relatedCluId, String cluCluRelationTypeKey, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
CluService
getCluIdsByRelatedCluAndRelationType
in interface CluService
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 failurepublic List<CluInfo> getRelatedClusByCluAndRelationType(String relatedCluId, String cluCLuRelationTypeKey, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
CluService
getRelatedClusByCluAndRelationType
in interface CluService
relatedCluId
- 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 failurepublic List<String> getRelatedCluIdsByCluAndRelationType(String cluId, String luLuRelationTypeKey, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException
CluService
getRelatedCluIdsByCluAndRelationType
in interface CluService
cluId
- identifier of the parent or From CLUluLuRelationTypeKey
- the LU to LU relation typecontext
- 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 requestpublic CluCluRelationInfo getCluCluRelation(String cluCluRelationId, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException
CluService
getCluCluRelation
in interface CluService
cluCluRelationId
- identifier of the CLU to CLU relationcontext
- 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 requestpublic List<CluCluRelationInfo> getCluCluRelationsByClu(String cluId, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException
CluService
getCluCluRelationsByClu
in interface CluService
cluId
- identifier of the parent or From CLUcontext
- 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 requestpublic List<CluPublicationInfo> getCluPublicationsByClu(String cluId, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException
CluService
getCluPublicationsByClu
in interface CluService
cluId
- clu identifiercontext
- 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 requestpublic List<CluPublicationInfo> getCluPublicationsByType(String luPublicationTypeKey, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException
CluService
getCluPublicationsByType
in interface CluService
luPublicationTypeKey
- luPublicationType identifiercontext
- 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 requestpublic CluPublicationInfo getCluPublication(String cluPublicationId, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException
CluService
getCluPublication
in interface CluService
cluPublicationId
- CLU publication identifiercontext
- 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 requestpublic CluResultInfo getCluResult(String cluResultId, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException
CluService
getCluResult
in interface CluService
cluResultId
- identifier of the Clu Resultcontext
- 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 requestpublic List<CluResultInfo> getCluResultByClu(String cluId, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException
CluService
getCluResultByClu
in interface CluService
cluId
- clu identifiercontext
- 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 requestpublic List<String> getCluIdsByResultUsageType(String resultUsageTypeKey, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException
CluService
getCluIdsByResultUsageType
in interface CluService
resultUsageTypeKey
- identifier of the result usage typecontext
- Context information containing the principalId
and locale information about the caller of
service operationDoesNotExistException
- resultUsageType not foundInvalidParameterException
- invalid resultUsageTypeKeyMissingParameterException
- missing resultUsageTypeKeyOperationFailedException
- unable to complete requestpublic List<String> getCluIdsByResultComponent(String resultComponentId, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException
CluService
getCluIdsByResultComponent
in interface CluService
resultComponentId
- identifier of the result componentcontext
- Context information containing the principalId
and locale information about the caller of
service operationDoesNotExistException
- resultComponent not foundInvalidParameterException
- invalid resultComponentIdMissingParameterException
- missing resultComponentIdOperationFailedException
- unable to complete requestpublic CluLoRelationInfo getCluLoRelation(String cluLoRelationId, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
CluService
getCluLoRelation
in interface CluService
cluLoRelationId
- Identifier of the CLU LO Relationcontext
- 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 failurepublic List<CluLoRelationInfo> getCluLoRelationsByClu(String cluId, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException
CluService
getCluLoRelationsByClu
in interface CluService
cluId
- Identifier for the CLUcontext
- 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 requestpublic List<CluLoRelationInfo> getCluLoRelationsByLo(String loId, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException
CluService
getCluLoRelationsByLo
in interface CluService
loId
- Identifier for the learning objectivecontext
- 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 requestpublic List<String> getResourceRequirementsForClu(String cluId, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException
CluService
getResourceRequirementsForClu
in interface CluService
cluId
- Unique identifier for the CLUcontext
- 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 requestpublic CluSetInfo getCluSet(String cluSetId, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
CluService
getCluSet
in interface CluService
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 failurepublic CluSetTreeViewInfo getCluSetTreeView(String cluSetId, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
CluService
getCluSetTreeView
in interface CluService
cluSetId
- Identifier of the CLU setcontext
- 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 failurepublic List<CluSetInfo> getCluSetsByIds(List<String> cluSetIds, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
CluService
getCluSetsByIds
in interface CluService
cluSetIds
- List of identifiers of CLU setscontext
- 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 failurepublic List<String> getCluSetIdsFromCluSet(String cluSetId, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
CluService
getCluSetIdsFromCluSet
in interface CluService
cluSetId
- Identifier of the CLU setcontext
- 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 failurepublic Boolean isCluSetDynamic(String cluSetId, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
CluService
isCluSetDynamic
in interface CluService
cluSetId
- Identifier of the CLU setcontext
- 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 failurepublic List<CluInfo> getClusFromCluSet(String cluSetId, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
CluService
getClusFromCluSet
in interface CluService
cluSetId
- Identifier of the CLU setcontext
- 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 failurepublic List<String> getCluIdsFromCluSet(String cluSetId, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
CluService
getCluIdsFromCluSet
in interface CluService
cluSetId
- Identifier of the CLU setcontext
- 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 failurepublic List<CluInfo> getAllClusInCluSet(String cluSetId, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
CluService
getAllClusInCluSet
in interface CluService
cluSetId
- Identifier of the CLU setcontext
- 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 failurepublic List<String> getAllCluIdsInCluSet(String cluSetId, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
CluService
getAllCluIdsInCluSet
in interface CluService
cluSetId
- Identifier of the CLU setcontext
- 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 failurepublic Boolean isCluInCluSet(String cluId, String cluSetId, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
CluService
isCluInCluSet
in interface CluService
cluId
- Identifier of the CLU to checkcluSetId
- Identifier of the CLU setcontext
- 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 failurepublic List<ValidationResultInfo> validateClu(String validationType, CluInfo cluInfo, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException
validateClu
in interface CluService
validationType
- identifier of the extent of validationcluInfo
- CLU information to be tested.context
- 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 request@Transactional(readOnly=false) public CluInfo createClu(String luTypeKey, CluInfo cluInfo, ContextInfo context) throws DataValidationErrorException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
CluService
createClu
in interface CluService
luTypeKey
- identifier of the LU Type for the CLU being createdcluInfo
- information about the CLU being createdcontext
- 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 failurepublic Clu toCluForCreate(String luTypeKey, CluInfo cluInfo, ContextInfo context) throws AlreadyExistsException, DataValidationErrorException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
@Transactional(readOnly=false) public CluInfo updateClu(String cluId, CluInfo cluInfo, ContextInfo context) throws DataValidationErrorException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, VersionMismatchException
CluService
updateClu
in interface CluService
cluId
- identifier for the CLU to be updatedcluInfo
- updated information about the CLUcontext
- 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 failureVersionMismatchException
- an optimistic locking failure or the
action was attempted on an out of
date version@Transactional(readOnly=false) public StatusInfo deleteClu(String cluId, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, DependentObjectsExistException, OperationFailedException, PermissionDeniedException
CluService
deleteClu
in interface CluService
cluId
- identifier for the CLU to be deletedcontext
- Context information containing the principalId and
locale information about the caller of service
operationDoesNotExistException
- cluId not foundInvalidParameterException
- invalid contextInfoMissingParameterException
- missing cluId or contextInfoDependentObjectsExistException
- delete would leave orphaned
objects or violate integrity
constraintsOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure@Transactional(readOnly=false) public CluInfo updateCluState(String cluId, String luState, ContextInfo context) throws DataValidationErrorException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
CluService
updateCluState
in interface CluService
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.context
- 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 failurepublic List<ValidationResultInfo> validateCluCluRelation(String validationTypeKey, String cluId, String relatedCluId, String cluCluRelationTypeKey, CluCluRelationInfo cluCluRelationInfo, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
CluService
validateCluCluRelation
in interface CluService
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 failure@Transactional(readOnly=false) public CluCluRelationInfo createCluCluRelation(String cluId, String relatedCluId, String luLuRelationTypeKey, CluCluRelationInfo cluCluRelationInfo, ContextInfo context) throws DataValidationErrorException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, CircularRelationshipException
CluService
createCluCluRelation
in interface CluService
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 RelationluLuRelationTypeKey
- the LU to LU relationship type of the
relationshipcluCluRelationInfo
- information about the relationship between
the two CLUscontext
- Context information containing the
principalId and locale information about the
caller of service operationDataValidationErrorException
- 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 failureCircularRelationshipException
- cluId equals relatedCluId@Transactional(readOnly=false) public CluCluRelationInfo updateCluCluRelation(String cluCluRelationId, CluCluRelationInfo cluCluRelationInfo, ContextInfo context) throws DataValidationErrorException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, VersionMismatchException
CluService
updateCluCluRelation
in interface CluService
cluCluRelationId
- identifier of the CLU to CLU relation to be
updatedcluCluRelationInfo
- changed information about the CLU to CLU
relationshipcontext
- 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 failureVersionMismatchException
- an optimistic locking failure or the
action was attempted on an out of
date version@Transactional(readOnly=false) public StatusInfo deleteCluCluRelation(String cluCluRelationId, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
CluService
deleteCluCluRelation
in interface CluService
cluCluRelationId
- identifier of CLU to CLU relationship to deletecontext
- 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 failurepublic List<ValidationResultInfo> validateCluPublication(String validationType, String cluId, String luPublicationTypeKey, CluPublicationInfo cluPublicationInfo, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException
CluService
validateCluPublication
in interface CluService
validationType
- identifier of the extent of validationcluId
- identifier of a cluluPublicationTypeKey
- type of lu publicationcluPublicationInfo
- CLU publication information to be tested.context
- 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 request@Transactional(readOnly=false) public CluPublicationInfo createCluPublication(String cluId, String luPublicationType, CluPublicationInfo cluPublicationInfo, ContextInfo context) throws DataValidationErrorException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
CluService
createCluPublication
in interface CluService
cluId
- identifier of a cluluPublicationType
- type of lu publicationcluPublicationInfo
- information about publication for a clucontext
- Context information containing the
principalId and locale information about the
caller of service operationDataValidationErrorException
- supplied data is invalidInvalidParameterException
- invalid cluPublicationInfo or
contextInfoMissingParameterException
- missing cluId, luPublicationTypeKey,
cluPublicationInfo or contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure@Transactional(readOnly=false) public CluPublicationInfo updateCluPublication(String cluPublicationId, CluPublicationInfo cluPublicationInfo, ContextInfo context) throws DataValidationErrorException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, VersionMismatchException
CluService
updateCluPublication
in interface CluService
cluPublicationId
- identifier for the clu publication object to be
updatedcluPublicationInfo
- updated information about the clu publication
objectcontext
- 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 failureVersionMismatchException
- The action was attempted on an out
of date version.@Transactional(readOnly=false) public StatusInfo deleteCluPublication(String cluPublicationId, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, DependentObjectsExistException, OperationFailedException, PermissionDeniedException
CluService
deleteCluPublication
in interface CluService
cluPublicationId
- identifier for the clu publication object to be
deletedcontext
- Context information containing the principalId
and locale information about the caller of
service operationDoesNotExistException
- cluPublicationId not foundInvalidParameterException
- invalid contextInfoMissingParameterException
- missing cluPublicationId or
contextInfoDependentObjectsExistException
- delete would leave orphaned
objects or violate integrity
constraintsOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failurepublic List<ValidationResultInfo> validateCluResult(String validationType, String cluId, String cluResultTypeKey, CluResultInfo cluResultInfo, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException
CluService
validateCluResult
in interface CluService
validationType
- identifier of the extent of validationcluId
- identifier of a clucluResultTypeKey
- type of clu resultcluResultInfo
- CLU result information to be tested.context
- 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 request@Transactional(readOnly=false) public CluResultInfo createCluResult(String cluId, String cluResultTypeKey, CluResultInfo cluResultInfo, ContextInfo context) throws DataValidationErrorException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, DoesNotExistException
CluService
createCluResult
in interface CluService
cluId
- identifier of a clucluResultTypeKey
- type of clu resultcluResultInfo
- information about potential results for a clucontext
- Context information containing the principalId
and locale information about the caller of
service operationDataValidationErrorException
- supplied data is invalidInvalidParameterException
- invalid cluResultInfo or contextInfoMissingParameterException
- missing cluId, cluResultTypeKey,
cluResultInfo or contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureDoesNotExistException
- cluId or resultUsageTypeKey not
found@Transactional(readOnly=false) public CluResultInfo updateCluResult(String cluResultId, CluResultInfo cluResultInfo, ContextInfo context) throws DataValidationErrorException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, VersionMismatchException
CluService
updateCluResult
in interface CluService
cluResultId
- identifier for the clu result to be updatedcluResultInfo
- updated information about the clu resultcontext
- 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 failureVersionMismatchException
- an optimistic locking failure or the
action was attempted on an out of
date version@Transactional(readOnly=false) public StatusInfo deleteCluResult(String cluResultId, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, DependentObjectsExistException, OperationFailedException, PermissionDeniedException
CluService
deleteCluResult
in interface CluService
cluResultId
- identifier for the clu result to be deletedcontext
- 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 failurepublic List<ValidationResultInfo> validateCluLoRelation(String validationType, String cluId, String loId, String cluLoRelationType, CluLoRelationInfo cluLoRelationInfo, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException
CluService
validateCluLoRelation
in interface CluService
validationType
- identifier of the extent of validationcluId
- CLU identifierloId
- learning objective identifiercluLoRelationType
- type of clu learning objective relationshipcluLoRelationInfo
- cluLoRelation information to be tested.context
- 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 request@Transactional(readOnly=false) public CluLoRelationInfo createCluLoRelation(String cluId, String loId, String cluLoRelationType, CluLoRelationInfo cluLoRelationInfo, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, DataValidationErrorException
CluService
createCluLoRelation
in interface CluService
cluId
- CLU identifierloId
- learning objective identifiercluLoRelationType
- type of clu learning objective relationshipcluLoRelationInfo
- clu learning objective relationship
informationcontext
- Context information containing the
principalId and locale information about the
caller of service operationDoesNotExistException
- cluId, loId, cluLoRelationTypeKey
not foundInvalidParameterException
- invalid cluLoRelationInfo or
contextInfoMissingParameterException
- missing cluId, loId, cluLoRelationTypeKey,
cluLoRelationInfo or contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureDataValidationErrorException
- data validation error@Transactional(readOnly=false) public CluLoRelationInfo updateCluLoRelation(String cluLoRelationId, CluLoRelationInfo cluLoRelationInfo, ContextInfo context) throws DataValidationErrorException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, VersionMismatchException
CluService
updateCluLoRelation
in interface CluService
cluLoRelationId
- identifier of the clu learning objective
relationship to be updatedcluLoRelationInfo
- information about the clu learning objective
relationship to be updatedcontext
- 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 failureVersionMismatchException
- The action was attempted on an out
of date version.@Transactional(readOnly=false) public StatusInfo deleteCluLoRelation(String cluLoRelationId, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
CluService
deleteCluLoRelation
in interface CluService
cluLoRelationId
- CLU learning objective Relationship identifiercontext
- 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 failure@Transactional(readOnly=false) public StatusInfo addCluResourceRequirement(String resourceTypeKey, String cluId, ContextInfo context) throws AlreadyExistsException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
CluService
addCluResourceRequirement
in interface CluService
resourceTypeKey
- identifier of the resource requirement type to be
added to the CLUcluId
- identifier of the CLUcontext
- 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 failure@Transactional(readOnly=false) public StatusInfo removeCluResourceRequirement(String resourceTypeKey, String cluId, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
CluService
removeCluResourceRequirement
in interface CluService
resourceTypeKey
- identifier of the resource type to be removed from
the CLUcluId
- identifier of the CLUcontext
- 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 failurepublic List<ValidationResultInfo> validateCluSet(String validationType, String cluSetType, CluSetInfo cluSetInfo, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException
CluService
validateCluSet
in interface CluService
validationType
- identifier of the extent of validationcluSetType
- type of the CLU set to be createdcluSetInfo
- CLU set information to be tested.context
- 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 request@Transactional(readOnly=false) public CluSetInfo createCluSet(String cluSetType, CluSetInfo cluSetInfo, ContextInfo contextInfo) throws DataValidationErrorException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, UnsupportedActionException
CluService
createCluSet
in interface CluService
cluSetType
- 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 errorInvalidParameterException
- invalid cluSetInfo or contextInfoMissingParameterException
- missing cluSetTypeKey, cluSetInfo or
contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedActionException
- CLU set need to be static or dynamic
but not both@Transactional(readOnly=false) public CluSetInfo updateCluSet(String cluSetId, CluSetInfo cluSetInfo, ContextInfo contextInfo) throws DataValidationErrorException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, VersionMismatchException, CircularRelationshipException, UnsupportedActionException
CluService
updateCluSet
in interface CluService
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
operationDataValidationErrorException
- data validation errorDoesNotExistException
- cluSetId not foundInvalidParameterException
- invalid cluSetInfo or contextInfoMissingParameterException
- missing cluSetId, cluSetInfo or
contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureVersionMismatchException
- an optimistic locking failure or
the action was attempted on an out
of date versionCircularRelationshipException
- added CluSetId cannot be added to
the cluSetInfoUnsupportedActionException
- CLU set need to be static or
dynamic but not both@Transactional(readOnly=false) public StatusInfo deleteCluSet(String cluSetId, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
CluService
deleteCluSet
in interface CluService
cluSetId
- identifier of the CLU set to be deletedcontext
- 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 failure@Transactional(readOnly=false) public StatusInfo addCluSetToCluSet(String cluSetId, String addedCluSetId, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, UnsupportedActionException, CircularRelationshipException
CluService
addCluSetToCluSet
in interface CluService
cluSetId
- identifier of the host CLU setaddedCluSetId
- identifier of the CLU set to be addedcontext
- Context information containing the principalId and
locale information about the caller of service
operationDoesNotExistException
- cluSetId, addedCluSetId not foundInvalidParameterException
- invalid contextInfoMissingParameterException
- missing cluSetId, addedCluSetId or
contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedActionException
- CLU set is dynamically determinedCircularRelationshipException
- addedCluSetId cannot be added to
the CluSetId@Transactional(readOnly=false) public StatusInfo removeCluSetFromCluSet(String cluSetId, String removedCluSetId, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, UnsupportedActionException
CluService
removeCluSetFromCluSet
in interface CluService
cluSetId
- identifier of the host CLU setremovedCluSetId
- identifier of the CLU set to be removedcontext
- 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 determined@Transactional(readOnly=false) public StatusInfo addCluToCluSet(String cluId, String cluSetId, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, UnsupportedActionException
CluService
addCluToCluSet
in interface CluService
cluId
- identifier of CLU to add to the CLU setcluSetId
- identifier of the CLU setcontext
- 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 determined@Transactional(readOnly=false) public StatusInfo removeCluFromCluSet(String cluId, String cluSetId, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, UnsupportedActionException
CluService
removeCluFromCluSet
in interface CluService
cluId
- identifier of CLU to remove from the CLU setcluSetId
- identifier of the CLU setcontext
- 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 determined@Transactional(readOnly=false) public StatusInfo addCluSetsToCluSet(String cluSetId, List<String> cluSetIds, ContextInfo context) throws CircularRelationshipException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, UnsupportedActionException
CluService
addCluSetsToCluSet
in interface CluService
cluSetId
- identifier of the host CLU setcluSetIds
- list of identifiers of the CLU sets to be addedcontext
- 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 determined@Transactional(readOnly=false) public StatusInfo addClusToCluSet(List<String> cluIds, String cluSetId, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, UnsupportedActionException
CluService
addClusToCluSet
in interface CluService
cluIds
- list of identifiers of CLUs to add to the CLU setcluSetId
- identifier of the CLU set to be addedcontext
- 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 determinedpublic ValidatorFactory getValidatorFactory()
public void setValidatorFactory(ValidatorFactory validatorFactory)
@Transactional(readOnly=false) public CluInfo createNewCluVersion(String versionIndCluId, String versionComment, ContextInfo context) throws DataValidationErrorException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
createNewCluVersion
in interface CluService
versionIndCluId
- identifier for the CLU to be versionedversionComment
- comment for the current versioncontext
- 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 failure@Transactional(readOnly=false) public StatusInfo setCurrentCluVersion(String cluVersionId, Date currentVersionStart, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, IllegalVersionSequencingException, OperationFailedException, PermissionDeniedException
setCurrentCluVersion
in interface CluService
currentVersionStart
- if set to null, will default the current version start to the time when this method is called.
You can set this to a future date as well.cluVersionId
- Version Specific Id of the Clucontext
- Context information containing the principalId
and locale information about the caller of
service operationDoesNotExistException
- 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 failure@Transactional(readOnly=true) public SearchResultInfo search(SearchRequestInfo searchRequest, ContextInfo contextInfo) throws MissingParameterException, PermissionDeniedException, OperationFailedException, InvalidParameterException
SearchService
search
in interface SearchService
searchRequest
- the search requestcontextInfo
- information containing the principalId and locale
information about the caller of service operationMissingParameterException
- searchRequestInfo or contextInfo is
missing or nullPermissionDeniedException
- an authorization failure occurredOperationFailedException
- unable to complete requestInvalidParameterException
- contextInfo is not validpublic VersionDisplayInfo getLatestVersion(String refObjectTypeURI, String refObjectId, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
VersionManagementService
getLatestVersion
in interface VersionManagementService
refObjectTypeURI
- reference object type URIrefObjectId
- reference object Idcontext
- context information containing the principalId and
locale information about the caller of service
operationDoesNotExistException
- specified refObjectId and refObjectUri
not foundInvalidParameterException
- contextInfo is not validMissingParameterException
- refObjectUri, refObjectId or
contextInfo is missing or nullOperationFailedException
- unable to complete requestPermissionDeniedException
- an authorization failure occurredpublic VersionDisplayInfo getCurrentVersion(String refObjectTypeURI, String refObjectId, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
VersionManagementService
getCurrentVersion
in interface VersionManagementService
refObjectTypeURI
- reference object type URIrefObjectId
- reference object Idcontext
- context information containing the principalId and
locale information about the caller of service
operationDoesNotExistException
- specified refObjectUri and refObjectId
not foundInvalidParameterException
- contextInfo is not validMissingParameterException
- refObjectUri, refObjectId or
contextInfo is missing or nullOperationFailedException
- unable to complete requestPermissionDeniedException
- an authorization failure occurredpublic VersionDisplayInfo getCurrentVersionOnDate(String refObjectTypeURI, String refObjectId, Date date, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
VersionManagementService
getCurrentVersionOnDate
in interface VersionManagementService
refObjectTypeURI
- reference object type URIrefObjectId
- reference object Iddate
- datecontext
- context information containing the principalId and
locale information about the caller of service
operationDoesNotExistException
- specified refObjectId and refObjectUri
not foundInvalidParameterException
- date or contextInfo is not validMissingParameterException
- refObjectUri, refObjectId, date or
contextInfo is missing or nullOperationFailedException
- unable to complete requestPermissionDeniedException
- an authorization failure occurredpublic VersionDisplayInfo getFirstVersion(String refObjectTypeURI, String refObjectId, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
VersionManagementService
getFirstVersion
in interface VersionManagementService
refObjectTypeURI
- reference object type URIrefObjectId
- reference object Idcontext
- context information containing the principalId and
locale information about the caller of service
operationDoesNotExistException
- refObjectUri or refObjectId not foundInvalidParameterException
- contextInfo is not validMissingParameterException
- refObjectUri, refObjectId or
contextInfo is missing or nullOperationFailedException
- unable to complete requestPermissionDeniedException
- an authorization failure occurredpublic VersionDisplayInfo getVersionBySequenceNumber(String refObjectTypeURI, String refObjectId, Long sequence, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
VersionManagementService
getVersionBySequenceNumber
in interface VersionManagementService
refObjectTypeURI
- reference object type URIrefObjectId
- reference object Idsequence
- sequence numbercontext
- context information containing the principalId and
locale information about the caller of service
operationDoesNotExistException
- specified refObjectUri, refObjectId or
sequence not foundInvalidParameterException
- sequence or contextInfo is not validMissingParameterException
- refObjectUri, refObjectId, sequence or
contextInfo is missing or nullOperationFailedException
- unable to complete requestPermissionDeniedException
- an authorization failure occurredpublic List<VersionDisplayInfo> getVersions(String refObjectTypeURI, String refObjectId, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
VersionManagementService
getVersions
in interface VersionManagementService
refObjectTypeURI
- reference object type URIrefObjectId
- reference object Idcontext
- context information containing the principalId and
locale information about the caller of service
operationDoesNotExistException
- refObjectUri or refObjectId not foundInvalidParameterException
- invalid contextInfoMissingParameterException
- refObjectUri, refObjectId or
contextInfo is missing or nullOperationFailedException
- unable to complete requestPermissionDeniedException
- an authorization failure occurredpublic List<VersionDisplayInfo> getVersionsInDateRange(String refObjectTypeURI, String refObjectId, Date from, Date to, ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
VersionManagementService
getVersionsInDateRange
in interface VersionManagementService
refObjectTypeURI
- reference object type URIrefObjectId
- reference object Idfrom
- from dateto
- to datecontext
- context information containing the principalId and
locale information about the caller of service
operationDoesNotExistException
- specified refObjectId and refObjectUri
not foundInvalidParameterException
- from, to or contextInfo is not validMissingParameterException
- refObjectUri, refObjectId, from, to or
contextInfo is missing or nullOperationFailedException
- unable to complete requestPermissionDeniedException
- an authorization failure occurredpublic void setSearchDispatcher(SearchService searchDispatcher)
public List<CluResultInfo> getCluResultsByClus(List<String> cluIds, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException
CluService
getCluResultsByClus
in interface CluService
cluIds
- list of clu identifier'scontextInfo
- Context information containing the principalId and
locale information about the caller of service
operationDoesNotExistException
- one or more of the cludIds does not exist.InvalidParameterException
- invalid contextInfoMissingParameterException
- missing cluIds or contextInfoOperationFailedException
- unable to complete requestpublic List<CluInfo> searchForClus(QueryByCriteria criteria, ContextInfo contextInfo) throws InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
CluService
searchForClus
in interface CluService
criteria
- the search criteria.contextInfo
- Context information containing the principalId and
locale information about the caller of service
operationInvalidParameterException
- criteria or contextInfo is nullMissingParameterException
- missing criteria or contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failurepublic List<String> searchForCluIds(QueryByCriteria criteria, ContextInfo contextInfo) throws InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
CluService
searchForCluIds
in interface CluService
criteria
- the search criteria.contextInfo
- Context information containing the principalId and
locale information about the caller of service
operationInvalidParameterException
- criteria or contextInfo is nullMissingParameterException
- missing criteria or contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failurepublic List<CluCluRelationInfo> searchForCluCluRelations(QueryByCriteria criteria, ContextInfo contextInfo) throws InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
CluService
searchForCluCluRelations
in interface CluService
criteria
- the search criteria.contextInfo
- Context information containing the principalId and
locale information about the caller of service
operationInvalidParameterException
- criteria or contextInfo is nullMissingParameterException
- missing criteria or contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failurepublic List<String> searchForCluCluRelationIds(QueryByCriteria criteria, ContextInfo contextInfo) throws InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
CluService
searchForCluCluRelationIds
in interface CluService
criteria
- the search criteria.contextInfo
- Context information containing the principalId and
locale information about the caller of service
operationInvalidParameterException
- criteria or contextInfo is nullMissingParameterException
- missing criteria or contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failurepublic List<CluLoRelationInfo> searchForCluLoRelations(QueryByCriteria criteria, ContextInfo contextInfo) throws InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
CluService
searchForCluLoRelations
in interface CluService
criteria
- the search criteria.contextInfo
- Context information containing the principalId and
locale information about the caller of service
operationInvalidParameterException
- criteria or contextInfo is nullMissingParameterException
- missing criteria or contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failurepublic List<String> searchForCluLoRelationIds(QueryByCriteria criteria, ContextInfo contextInfo) throws InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
CluService
searchForCluLoRelationIds
in interface CluService
criteria
- the search criteria.contextInfo
- Context information containing the principalId and
locale information about the caller of service
operationInvalidParameterException
- criteria or contextInfo is nullMissingParameterException
- missing criteria or contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failurepublic List<CluPublicationInfo> searchForCluPublications(QueryByCriteria criteria, ContextInfo contextInfo) throws InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
CluService
searchForCluPublications
in interface CluService
criteria
- the search criteria.contextInfo
- Context information containing the principalId and
locale information about the caller of service
operationInvalidParameterException
- criteria or contextInfo is nullMissingParameterException
- missing criteria or contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failurepublic List<String> searchForCluPublicationIds(QueryByCriteria criteria, ContextInfo contextInfo) throws InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
CluService
searchForCluPublicationIds
in interface CluService
criteria
- the search criteria.contextInfo
- Context information containing the principalId and
locale information about the caller of service
operationInvalidParameterException
- criteria or contextInfo is nullMissingParameterException
- missing criteria or contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failurepublic List<CluResultInfo> searchForCluResults(QueryByCriteria criteria, ContextInfo contextInfo) throws InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
CluService
searchForCluResults
in interface CluService
criteria
- the search criteria.contextInfo
- Context information containing the principalId and
locale information about the caller of service
operationInvalidParameterException
- criteria or contextInfo is nullMissingParameterException
- missing criteria or contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failurepublic List<String> searchForCluResultIds(QueryByCriteria criteria, ContextInfo contextInfo) throws InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
CluService
searchForCluResultIds
in interface CluService
criteria
- the search criteria.contextInfo
- Context information containing the principalId and
locale information about the caller of service
operationInvalidParameterException
- criteria or contextInfo is nullMissingParameterException
- missing criteria or contextInfoOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureCopyright © 2004-2014 The Kuali Foundation. All Rights Reserved.