CluServiceImpl (Kuali Student 2.0.0-M5-SNAPSHOT API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.kuali.student.r2.lum.lu.service.impl
Class CluServiceImpl

java.lang.Object
  org.kuali.student.r2.lum.lu.service.impl.CluServiceImpl

All Implemented Interfaces:: SearchService, VersionManagementService, CluService

@Transactional(readOnly=true, noRollbackFor=DoesNotExistException.class, rollbackFor=java.lang.Throwable.class) public class CluServiceImpl
extends Object
implements CluService
extends Object
implements CluService

Nested Class Summary
`class`	`CluServiceImpl.SearchResultRowComparator`

Constructor Summary
`CluServiceImpl()`

Method Summary
`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 context)` 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
`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
`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 context)` 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
`SearchCriteriaTypeInfo`	`getSearchCriteriaType(String searchCriteriaTypeKey)` This method ...
`List<SearchCriteriaTypeInfo>`	`getSearchCriteriaTypes()` This method ...
`SearchManager`	`getSearchManager()`
`SearchResultTypeInfo`	`getSearchResultType(String searchResultTypeKey)` This method ...
`List<SearchResultTypeInfo>`	`getSearchResultTypes()` This method ...
`SearchTypeInfo`	`getSearchType(String searchTypeKey)` This method ...
`List<SearchTypeInfo>`	`getSearchTypes()` This method ...
`List<SearchTypeInfo>`	`getSearchTypesByCriteria(String searchCriteriaTypeKey)` This method ...
`List<SearchTypeInfo>`	`getSearchTypesByResult(String searchResultTypeKey)` This method ...
`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
`SearchResult`	`search(SearchRequest searchRequest)`
`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(SearchDispatcher 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 context)` 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.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

CluServiceImpl

public CluServiceImpl()

Method Detail

setDictionaryServiceDelegate

public void setDictionaryServiceDelegate(DictionaryService dictionaryServiceDelegate)

getDictionaryServiceDelegate

public DictionaryService getDictionaryServiceDelegate()

getSearchCriteriaType

public SearchCriteriaTypeInfo getSearchCriteriaType(String searchCriteriaTypeKey)
                                             throws DoesNotExistException,
                                                    InvalidParameterException,
                                                    MissingParameterException,
                                                    OperationFailedException

Description copied from interface: CluService

This method ...

Specified by:: getSearchCriteriaType in interface SearchService
Specified by:: getSearchCriteriaType in interface CluService

Parameters:: searchCriteriaTypeKey - identifier of the search criteria type
Returns:: information on the search criteria type
Throws:: DoesNotExistException - specified searchCriteriaTypeKey not found; InvalidParameterException - invalid searchCriteriaTypeKey; MissingParameterException - searchCriteriaTypeKey not specified; OperationFailedException - unable to complete request

getSearchCriteriaTypes

public List<SearchCriteriaTypeInfo> getSearchCriteriaTypes()
                                                    throws OperationFailedException

Description copied from interface: CluService

This method ...

Specified by:: getSearchCriteriaTypes in interface SearchService
Specified by:: getSearchCriteriaTypes in interface CluService

Returns:: list of search criteria type information
Throws:: OperationFailedException - unable to complete request

getSearchResultType

public SearchResultTypeInfo getSearchResultType(String searchResultTypeKey)
                                         throws DoesNotExistException,
                                                InvalidParameterException,
                                                MissingParameterException,
                                                OperationFailedException

Description copied from interface: CluService

This method ...

Specified by:: getSearchResultType in interface SearchService
Specified by:: getSearchResultType in interface CluService

Parameters:: searchResultTypeKey - identifier of the search result type
Returns:: information on the search result type
Throws:: DoesNotExistException - specified searchResultTypeKey not found; InvalidParameterException - invalid searchResultTypeKey; MissingParameterException - searchResultTypeKey not specified; OperationFailedException - unable to complete request

getSearchResultTypes

public List<SearchResultTypeInfo> getSearchResultTypes()
                                                throws OperationFailedException

Description copied from interface: CluService

This method ...

Specified by:: getSearchResultTypes in interface SearchService
Specified by:: getSearchResultTypes in interface CluService

Returns:: list of search result type information
Throws:: OperationFailedException - unable to complete request

getSearchType

public SearchTypeInfo getSearchType(String searchTypeKey)
                             throws DoesNotExistException,
                                    InvalidParameterException,
                                    MissingParameterException,
                                    OperationFailedException

Description copied from interface: CluService

This method ...

Specified by:: getSearchType in interface SearchService
Specified by:: getSearchType in interface CluService

Parameters:: searchTypeKey - identifier of the search type
Returns:: information on the search type
Throws:: DoesNotExistException - specified searchTypeKey not found; InvalidParameterException - invalid searchTypeKey; MissingParameterException - searchTypeKey not specified; OperationFailedException - unable to complete request

getSearchTypes

public List<SearchTypeInfo> getSearchTypes()
                                    throws OperationFailedException

Description copied from interface: CluService

This method ...

Specified by:: getSearchTypes in interface SearchService
Specified by:: getSearchTypes in interface CluService

Returns:: list of search type information
Throws:: OperationFailedException - unable to complete request

getSearchTypesByCriteria

public List<SearchTypeInfo> getSearchTypesByCriteria(String searchCriteriaTypeKey)
                                              throws DoesNotExistException,
                                                     InvalidParameterException,
                                                     MissingParameterException,
                                                     OperationFailedException

Description copied from interface: CluService

This method ...

Specified by:: getSearchTypesByCriteria in interface SearchService
Specified by:: getSearchTypesByCriteria in interface CluService

Parameters:: searchCriteriaTypeKey - identifier of the search criteria
Returns:: list of search type information
Throws:: DoesNotExistException - specified searchCriteriaTypeKey not found; InvalidParameterException - invalid searchCriteriaTypeKey; MissingParameterException - searchCriteriaTypeKey not specified; OperationFailedException - unable to complete request

getSearchTypesByResult

public List<SearchTypeInfo> getSearchTypesByResult(String searchResultTypeKey)
                                            throws DoesNotExistException,
                                                   InvalidParameterException,
                                                   MissingParameterException,
                                                   OperationFailedException

Description copied from interface: CluService

This method ...

Specified by:: getSearchTypesByResult in interface SearchService
Specified by:: getSearchTypesByResult in interface CluService

Parameters:: searchResultTypeKey - identifier of the search result type
Returns:: list of search type information
Throws:: DoesNotExistException - specified searchResultTypeKey not found; InvalidParameterException - invalid searchResultTypeKey; MissingParameterException - searchResultTypeKey not specified; OperationFailedException - unable to complete request

getSearchManager

public SearchManager getSearchManager()

setSearchManager

public void setSearchManager(SearchManager searchManager)

getDeliveryMethodTypes

public List<TypeInfo> getDeliveryMethodTypes(ContextInfo context)
                                      throws OperationFailedException

SETUP OPERATION *

Specified by:: getDeliveryMethodTypes in interface CluService

Parameters:: context - Context information containing the principalId and locale information about the caller of service operation
Returns:: list of delivery method type information
Throws:: OperationFailedException - unable to complete request

getDeliveryMethodType

public TypeInfo getDeliveryMethodType(String deliveryMethodTypeKey,
                                      ContextInfo context)
                               throws DoesNotExistException,
                                      InvalidParameterException,
                                      MissingParameterException,
                                      OperationFailedException

Description copied from interface: CluService

Retrieves information about a delivery method type

Specified by:: getDeliveryMethodType in interface CluService

Parameters:: deliveryMethodTypeKey - Key of the Delivery Method Type; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: information about a Delivery Method Type
Throws:: DoesNotExistException - deliveryMethodType not found; InvalidParameterException - invalid contextInfo; MissingParameterException - missing deliveryMethodType or contextInfo; OperationFailedException - unable to complete request

getInstructionalFormatTypes

public List<TypeInfo> getInstructionalFormatTypes(ContextInfo context)
                                           throws OperationFailedException

Description copied from interface: CluService

Retrieves the list of instructional format types

Specified by:: getInstructionalFormatTypes in interface CluService

Parameters:: context - Context information containing the principalId and locale information about the caller of service operation
Returns:: list of instructional format type information
Throws:: OperationFailedException - unable to complete request

getInstructionalFormatType

public TypeInfo getInstructionalFormatType(String instructionalFormatTypeKey,
                                           ContextInfo context)
                                    throws DoesNotExistException,
                                           InvalidParameterException,
                                           MissingParameterException,
                                           OperationFailedException

Description copied from interface: CluService

Retrieves information about a Instructional Format Type

Specified by:: getInstructionalFormatType in interface CluService

Parameters:: instructionalFormatTypeKey - Key of the Instructional Format Type; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: information about a Instructional Format Type
Throws:: DoesNotExistException - instructionalFormatTypeKey not found; InvalidParameterException - invalid contextInfo; MissingParameterException - missing instructionalFormatTypeKey or contextInfo; OperationFailedException - unable to complete request

getLuTypes

public List<TypeInfo> getLuTypes(ContextInfo context)
                          throws OperationFailedException

Description copied from interface: CluService

Retrieves the list of LU types

Specified by:: getLuTypes in interface CluService

Parameters:: context - Context information containing the principalId and locale information about the caller of service operation
Returns:: list of LU type information
Throws:: OperationFailedException - unable to complete request

getLuType

public TypeInfo getLuType(String luTypeKey,
                          ContextInfo context)
                   throws DoesNotExistException,
                          InvalidParameterException,
                          MissingParameterException,
                          OperationFailedException

Description copied from interface: CluService

Retrieves information about a LU Type

Specified by:: getLuType in interface CluService

Parameters:: luTypeKey - Key of the LU Type; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: information about a LU Type
Throws:: DoesNotExistException - luTypeKey not found; InvalidParameterException - invalid contextInfo; MissingParameterException - missing luTypeKey or contextInfo; OperationFailedException - unable to complete request

getLuCodeType

public TypeInfo getLuCodeType(String luCodeTypeKey,
                              ContextInfo context)
                       throws DoesNotExistException,
                              InvalidParameterException,
                              MissingParameterException,
                              OperationFailedException

Description copied from interface: CluService

Retrieves information about a learning unit code type

Specified by:: getLuCodeType in interface CluService

Parameters:: luCodeTypeKey - Key of the learning unit code type; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: information about a learning unit code type
Throws:: DoesNotExistException - luCodeTypeKey not found; InvalidParameterException - invalid contextInfo; MissingParameterException - missing luCodeTypeKey or contextInfo; OperationFailedException - unable to complete request

getLuCodeTypes

public List<TypeInfo> getLuCodeTypes(ContextInfo context)
                              throws OperationFailedException

Description copied from interface: CluService

Retrieves the list of learning unit code types

Specified by:: getLuCodeTypes in interface CluService

Parameters:: context - Context information containing the principalId and locale information about the caller of service operation
Returns:: list of lu code type information
Throws:: OperationFailedException - unable to complete request

getCluCluRelationTypes

public List<TypeInfo> getCluCluRelationTypes(ContextInfo context)
                                      throws OperationFailedException

Description copied from interface: CluService

Retrieves the complete list of LU to LU relation types

Specified by:: getCluCluRelationTypes in interface CluService

Parameters:: context - Context information containing the principalId and locale information about the caller of service operation
Returns:: list of LU to LU relation type information
Throws:: OperationFailedException - unable to complete request

getLuLuRelationType

public TypeInfo getLuLuRelationType(String luLuRelationTypeKey,
                                    ContextInfo context)
                             throws OperationFailedException,
                                    MissingParameterException,
                                    DoesNotExistException

Description copied from interface: CluService

Retrieves the LU to LU relation type

Specified by:: getLuLuRelationType in interface CluService

Parameters:: luLuRelationTypeKey - Key of the LU to LU Relation Type; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: LU to LU relation type information
Throws:: OperationFailedException - unable to complete request; MissingParameterException - missing cluCluRelationTypeKey or contextInfo; DoesNotExistException - cluCluRelationTypeKey not found

getAllowedLuLuRelationTypesForLuType

public List<String> getAllowedLuLuRelationTypesForLuType(String luTypeKey,
                                                         String relatedLuTypeKey,
                                                         ContextInfo context)
                                                  throws DoesNotExistException,
                                                         InvalidParameterException,
                                                         MissingParameterException,
                                                         OperationFailedException

Description copied from interface: CluService

Retrieves the list of allowed relation types between the two specified LU Types

Specified by:: getAllowedLuLuRelationTypesForLuType in interface CluService

Parameters:: luTypeKey - Key of the first LU Type; relatedLuTypeKey - Key of the second LU Type; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: list of LU to LU relation types
Throws:: DoesNotExistException - luTypeKey, relatedLuTypeKey not found; InvalidParameterException - invalid contextInfo; MissingParameterException - missing luTypeKey, relatedLuTypeKey or contextInfo; OperationFailedException - unable to complete request

getLuPublicationTypes

public List<TypeInfo> getLuPublicationTypes(ContextInfo context)
                                     throws OperationFailedException

Description copied from interface: CluService

Retrieves the list of Learning Unit publication types

Specified by:: getLuPublicationTypes in interface CluService

Parameters:: context - Context information containing the principalId and locale information about the caller of service operation
Returns:: list of Learning Unit publication type information
Throws:: OperationFailedException - unable to complete request

getLuPublicationType

public TypeInfo getLuPublicationType(String luPublicationTypeKey,
                                     ContextInfo context)
                              throws DoesNotExistException,
                                     InvalidParameterException,
                                     MissingParameterException,
                                     OperationFailedException

Description copied from interface: CluService

Retrieves information about a publication type

Specified by:: getLuPublicationType in interface CluService

Parameters:: luPublicationTypeKey - Key of the Learning Unit Publication Type; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: information about a Learning Unit Publication Type
Throws:: DoesNotExistException - luPublicationTypeKey not found; InvalidParameterException - invalid contextInfo; MissingParameterException - missing luPublicationTypeKey or contextInfo; OperationFailedException - unable to complete request

getLuPublicationTypesForLuType

public List<String> getLuPublicationTypesForLuType(String luTypeKey,
                                                   ContextInfo context)
                                            throws DoesNotExistException,
                                                   InvalidParameterException,
                                                   MissingParameterException,
                                                   OperationFailedException

Description copied from interface: CluService

Retrieves information about a publication type

Specified by:: getLuPublicationTypesForLuType in interface CluService

Parameters:: luTypeKey - Key of the LU Type; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: list of LU publication types
Throws:: DoesNotExistException - luTypeKey not found; InvalidParameterException - invalid contextInfo; MissingParameterException - missing luTypeKey or contextInfo; OperationFailedException - unable to complete request

getCluResultTypes

public List<TypeInfo> getCluResultTypes(ContextInfo context)
                                 throws OperationFailedException

Description copied from interface: CluService

Retrieves a list of types for clu result objects.

Specified by:: getCluResultTypes in interface CluService

Parameters:: context - Context information containing the principalId and locale information about the caller of service operation
Returns:: list of clu result type information
Throws:: OperationFailedException - unable to complete request

getCluResultType

public TypeInfo getCluResultType(String cluResultTypeKey,
                                 ContextInfo context)
                          throws DoesNotExistException,
                                 InvalidParameterException,
                                 MissingParameterException,
                                 OperationFailedException

Description copied from interface: CluService

Retrieves information about a publication type

Specified by:: getCluResultType in interface CluService

Parameters:: cluResultTypeKey - Key of the Canonical Learning Unit Result Type; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: information about a Learning Unit Publication Type
Throws:: DoesNotExistException - cluResultTypeKey not found; InvalidParameterException - invalid contextInfo; MissingParameterException - missing cluResultTypeKey or contextInfo; OperationFailedException - unable to complete request

getCluResultTypesForLuType

public List<TypeInfo> getCluResultTypesForLuType(String luTypeKey,
                                                 ContextInfo context)
                                          throws DoesNotExistException,
                                                 InvalidParameterException,
                                                 MissingParameterException,
                                                 OperationFailedException

Description copied from interface: CluService

Retrieves the list of clu result types which are allowed to be used in conjunction with a particular lu type.

Specified by:: getCluResultTypesForLuType in interface CluService

Parameters:: luTypeKey - luTypeKey; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: list of clu result types
Throws:: DoesNotExistException - luTypeKey not found; InvalidParameterException - invalid contextInfo; MissingParameterException - missing luTypeKey or contextInfo; OperationFailedException - unable to complete request

getResultUsageTypes

public List<TypeInfo> getResultUsageTypes(ContextInfo context)
                                   throws OperationFailedException

Description copied from interface: CluService

Retrieves a list of result usage types

Specified by:: getResultUsageTypes in interface CluService

Parameters:: context - Context information containing the principalId and locale information about the caller of service operation
Returns:: list of result usage type information
Throws:: OperationFailedException - unable to complete request

getResultUsageType

public TypeInfo getResultUsageType(String resultUsageTypeKey,
                                   ContextInfo context)
                            throws DoesNotExistException,
                                   InvalidParameterException,
                                   MissingParameterException,
                                   OperationFailedException

Description copied from interface: CluService

Retrieves information about a Result Usage Type

Specified by:: getResultUsageType in interface CluService

Parameters:: resultUsageTypeKey - Key of the Result Usage Type; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: information about a Result Usage Type
Throws:: DoesNotExistException - resultUsageTypeKey not found; InvalidParameterException - invalid contextInfo; MissingParameterException - missing resultUsageTypeKey or contextInfo; OperationFailedException - unable to complete request

getAllowedResultUsageTypesForLuType

public List<String> getAllowedResultUsageTypesForLuType(String luTypeKey,
                                                        ContextInfo context)
                                                 throws DoesNotExistException,
                                                        InvalidParameterException,
                                                        MissingParameterException,
                                                        OperationFailedException

Description copied from interface: CluService

Retrieves the list of result usage types which are allowed to be used in conjunction with an lu type.

Specified by:: getAllowedResultUsageTypesForLuType in interface CluService

Parameters:: luTypeKey - luTypeKey; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: list of result usage types
Throws:: DoesNotExistException - luTypeKey not found; InvalidParameterException - invalid contextInfo; MissingParameterException - missing luTypeKey or contextInfo; OperationFailedException - unable to complete request

getAllowedResultComponentTypesForResultUsageType

public List<String> getAllowedResultComponentTypesForResultUsageType(String resultUsageTypeKey,
                                                                     ContextInfo context)
                                                              throws DoesNotExistException,
                                                                     InvalidParameterException,
                                                                     MissingParameterException,
                                                                     OperationFailedException

Description copied from interface: CluService

Retrieves the list of result component types which are allowed to be used in conjunction with result usage type.

Specified by:: getAllowedResultComponentTypesForResultUsageType in interface CluService

Parameters:: resultUsageTypeKey - resultUsageTypeKey; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: list of result component types
Throws:: DoesNotExistException - resultUsageTypeKey not found; InvalidParameterException - invalid contextInfo; MissingParameterException - missing resultUsageTypeKey or contextInfo; OperationFailedException - unable to complete request

getCluLoRelationType

public TypeInfo getCluLoRelationType(String cluLoRelationTypeKey,
                                     ContextInfo context)
                              throws DoesNotExistException,
                                     InvalidParameterException,
                                     MissingParameterException,
                                     OperationFailedException

Description copied from interface: CluService

Retrieves information for a specified CLU to LO relation type

Specified by:: getCluLoRelationType in interface CluService

Parameters:: cluLoRelationTypeKey - Key of the CLU to LO Relation Type; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: CLU to LO relation type information
Throws:: DoesNotExistException - cluLoRelationTypeKey not found; InvalidParameterException - invalid contextInfo; MissingParameterException - missing cluLoRelationTypeKey or contextInfo; OperationFailedException - unable to complete request

getCluLoRelationTypes

public List<TypeInfo> getCluLoRelationTypes(ContextInfo context)
                                     throws OperationFailedException

Description copied from interface: CluService

Retrieves the complete list of CLU to LO relation types

Specified by:: getCluLoRelationTypes in interface CluService

Parameters:: context - Context information containing the principalId and locale information about the caller of service operation
Returns:: list of CLU to LO relation type information
Throws:: OperationFailedException - unable to complete request

getAllowedCluLoRelationTypesForLuType

public List<String> getAllowedCluLoRelationTypesForLuType(String luTypeKey,
                                                          ContextInfo context)
                                                   throws DoesNotExistException,
                                                          InvalidParameterException,
                                                          MissingParameterException,
                                                          OperationFailedException

Description copied from interface: CluService

Retrieves the list of CLU LO relation types which are allowed to be used in conjunction with an lu type.

Specified by:: getAllowedCluLoRelationTypesForLuType in interface CluService

Parameters:: luTypeKey - luTypeKey; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: list of clu lo relation types
Throws:: DoesNotExistException - luTypeKey not found; InvalidParameterException - invalid contextInfo; MissingParameterException - missing luTypeKey or contextInfo; OperationFailedException - unable to complete request

getCluSetTypes

public List<TypeInfo> getCluSetTypes(ContextInfo context)
                              throws OperationFailedException

Description copied from interface: CluService

Retrieves the list of CLU set types known by the service

Specified by:: getCluSetTypes in interface CluService

Parameters:: context - Context information containing the principalId and locale information about the caller of service operation
Returns:: list of CLU set type information
Throws:: OperationFailedException - unable to complete request

getCluSetType

public TypeInfo getCluSetType(String cluSetTypeKey,
                              ContextInfo context)
                       throws DoesNotExistException,
                              InvalidParameterException,
                              MissingParameterException,
                              OperationFailedException

Description copied from interface: CluService

Retrieves information about a specified CLU set type

Specified by:: getCluSetType in interface CluService

Parameters:: cluSetTypeKey - Key of the CLU set type; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: information about a CLU set type
Throws:: DoesNotExistException - cluSetTypeKey not found; InvalidParameterException - invalid contextInfo; MissingParameterException - missing cluSetTypeKey or contextInfo; OperationFailedException - unable to complete request

getClu

public CluInfo getClu(String cluId,
                      ContextInfo context)
               throws DoesNotExistException,
                      InvalidParameterException,
                      MissingParameterException,
                      OperationFailedException

READ OPERATION *

Specified by:: getClu in interface CluService

Parameters:: cluId - identifier of the CLU; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: information about a CLU
Throws:: DoesNotExistException - cluId not found; InvalidParameterException - invalid contextInfo; MissingParameterException - missing cluId or contextInfo; OperationFailedException - unable to complete request

getClusByIds

public List<CluInfo> getClusByIds(List<String> cluIds,
                                  ContextInfo context)
                           throws DoesNotExistException,
                                  InvalidParameterException,
                                  MissingParameterException,
                                  OperationFailedException

Description copied from interface: CluService

Retrieves information about CLUs from a list of Ids

Specified by:: getClusByIds in interface CluService

Parameters:: cluIds - List of CLU identifiers; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: information a list of CLUs
Throws:: DoesNotExistException - One or more cluIds not found; InvalidParameterException - invalid contextInfo; MissingParameterException - missing cluIds or contextInfo; OperationFailedException - unable to complete request

getClusByLuType

public List<CluInfo> getClusByLuType(String luTypeKey,
                                     String luState,
                                     ContextInfo context)
                              throws DoesNotExistException,
                                     InvalidParameterException,
                                     MissingParameterException,
                                     OperationFailedException

Description copied from interface: CluService

Retrieves the list of CLUs for the specified LU Type and state

Specified by:: getClusByLuType in interface CluService

Parameters:: luTypeKey - Type of the CLUs to retrieve; luState - State of the CLUs to retrieve.; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: list of CLU information
Throws:: DoesNotExistException - luTypeKey or luState not found; InvalidParameterException - invalid contextInfo; MissingParameterException - missing luTypeKey, luState or contextInfo; OperationFailedException - unable to complete request

getCluIdsByLuType

public List<String> getCluIdsByLuType(String luTypeKey,
                                      String luState,
                                      ContextInfo context)
                               throws DoesNotExistException,
                                      InvalidParameterException,
                                      MissingParameterException,
                                      OperationFailedException

Description copied from interface: CluService

Retrieves the list of CLU Ids for the specified LU Type and state

Specified by:: getCluIdsByLuType in interface CluService

Parameters:: luTypeKey - Type of the CLUs whose identifiers should be retrieved; luState - State of the CLUs whose identifiers should be retrieved; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: list of CLU identifiers
Throws:: DoesNotExistException - luType or luState not found; InvalidParameterException - invalid contextInfo; MissingParameterException - missing luType, luState or contextInfo; OperationFailedException - unable to complete request

getAllowedCluCluRelationTypesByClu

public List<String> getAllowedCluCluRelationTypesByClu(String cluId,
                                                       String relatedCluId,
                                                       ContextInfo context)
                                                throws DoesNotExistException,
                                                       InvalidParameterException,
                                                       MissingParameterException,
                                                       OperationFailedException

Description copied from interface: CluService

Retrieves the list of allowed relation types between the two specified CLUs

Specified by:: getAllowedCluCluRelationTypesByClu in interface CluService

Parameters:: cluId - identifier of the first CLU; relatedCluId - identifier of the second CLU; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: list of LU to LU relation types
Throws:: DoesNotExistException - cluId, relatedCluId not found; InvalidParameterException - invalid contextInfo; MissingParameterException - missing cluId, relatedCluId or contextInfo; OperationFailedException - unable to complete request

getClusByRelatedCluAndRelationType

public List<CluInfo> getClusByRelatedCluAndRelationType(String relatedCluId,
                                                        String luLuRelationTypeKey,
                                                        ContextInfo context)
                                                 throws DoesNotExistException,
                                                        InvalidParameterException,
                                                        MissingParameterException,
                                                        OperationFailedException

Description copied from interface: CluService

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)

Specified by:: getClusByRelatedCluAndRelationType in interface CluService

Parameters:: relatedCluId - identifier of the child or To CLU; luLuRelationTypeKey - the LU to LU relation type; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: list of CLU information
Throws:: DoesNotExistException - relatedCluId, cluCLuRelationTypeKey not found; InvalidParameterException - invalid contextInfo; MissingParameterException - missing relatedCluId, cluCLuRelationTypeKey or contextInfo; OperationFailedException - unable to complete request

getCluIdsByRelatedCluAndRelationType

public List<String> getCluIdsByRelatedCluAndRelationType(String relatedCluId,
                                                         String cluCluRelationTypeKey,
                                                         ContextInfo contextInfo)
                                                  throws DoesNotExistException,
                                                         InvalidParameterException,
                                                         MissingParameterException,
                                                         OperationFailedException,
                                                         PermissionDeniedException

Description copied from interface: CluService

Retrieves the list of CLU Ids for the specified related CLU Id and LU to LU relation type (getRelatedCluIdsByCluAndRelationType from the other direction)

Specified by:: getCluIdsByRelatedCluAndRelationType in interface CluService

Parameters:: relatedCluId - identifier of the child or To CLU; cluCluRelationTypeKey - the LU to LU relation type; contextInfo - Context information containing the principalId and locale information about the caller of service operation
Returns:: list of CLU identifiers
Throws:: DoesNotExistException - relatedCluId or cluCluRelationTypeKey not found; InvalidParameterException - invalid contextInfo; MissingParameterException - missing relatedCluId, cluCluRelationTypeKey or contextInfo; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

getRelatedClusByCluAndRelationType

public List<CluInfo> getRelatedClusByCluAndRelationType(String relatedCluId,
                                                        String cluCLuRelationTypeKey,
                                                        ContextInfo contextInfo)
                                                 throws DoesNotExistException,
                                                        InvalidParameterException,
                                                        MissingParameterException,
                                                        OperationFailedException,
                                                        PermissionDeniedException

Description copied from interface: CluService

Retrieves the list of related CLU information for the specified CLU Id and LU to LU relation type (getClusByRelation from the other direction)

Specified by:: getRelatedClusByCluAndRelationType in interface CluService

Parameters:: relatedCluId - identifier of the parent or From CLU; cluCLuRelationTypeKey - the LU to LU relation type; contextInfo - Context information containing the principalId and locale information about the caller of service operation
Returns:: list of CLU information
Throws:: DoesNotExistException - cluId or cluCluRelationTypeKey not found; InvalidParameterException - invalid contextInfo; MissingParameterException - missing cluId, cluCluRelationTypeKey or contextInfo; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

getRelatedCluIdsByCluAndRelationType

public List<String> getRelatedCluIdsByCluAndRelationType(String cluId,
                                                         String luLuRelationTypeKey,
                                                         ContextInfo context)
                                                  throws DoesNotExistException,
                                                         InvalidParameterException,
                                                         MissingParameterException,
                                                         OperationFailedException

Description copied from interface: CluService

Retrieves the list of related CLU Ids for the specified CLU Id and LU to LU relation type (getCluIdsByRelatedCluAndCluCluRelationType from the other direction)

Specified by:: getRelatedCluIdsByCluAndRelationType in interface CluService

Parameters:: cluId - identifier of the parent or From CLU; luLuRelationTypeKey - the LU to LU relation type; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: list of CLU identifiers
Throws:: DoesNotExistException - cluId, cluCluRelationTypeKey not found; InvalidParameterException - invalid contextInfo; MissingParameterException - missing cluId, cluCluRelationTypeKey; OperationFailedException - unable to complete request

getCluCluRelation

public CluCluRelationInfo getCluCluRelation(String cluCluRelationId,
                                            ContextInfo context)
                                     throws DoesNotExistException,
                                            InvalidParameterException,
                                            MissingParameterException,
                                            OperationFailedException

Description copied from interface: CluService

Retrieves the relationship information between CLUs for a particular Relation instance

Specified by:: getCluCluRelation in interface CluService

Parameters:: cluCluRelationId - identifier of the CLU to CLU relation; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: information on the relation between two CLUs
Throws:: DoesNotExistException - cluCluRelationId not found; InvalidParameterException - invalid contextInfo; MissingParameterException - missing cluCluRelationId or contextInfo; OperationFailedException - unable to complete request

getCluCluRelationsByClu

public List<CluCluRelationInfo> getCluCluRelationsByClu(String cluId,
                                                        ContextInfo context)
                                                 throws DoesNotExistException,
                                                        InvalidParameterException,
                                                        MissingParameterException,
                                                        OperationFailedException

Description copied from interface: CluService

Retrieves the list of relationship information for the specified CLU

Specified by:: getCluCluRelationsByClu in interface CluService

Parameters:: cluId - identifier of the parent or From CLU; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: list of CLU to CLU relation information
Throws:: DoesNotExistException - cluId not found; InvalidParameterException - invalid contextInfo; MissingParameterException - missing cluId or contextInfo; OperationFailedException - unable to complete request

getCluPublicationsByClu

public List<CluPublicationInfo> getCluPublicationsByClu(String cluId,
                                                        ContextInfo context)
                                                 throws DoesNotExistException,
                                                        InvalidParameterException,
                                                        MissingParameterException,
                                                        OperationFailedException

Description copied from interface: CluService

Retrieves a list of publication objects for a particular clu

Specified by:: getCluPublicationsByClu in interface CluService

Parameters:: cluId - clu identifier; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: list of publication objects used by the specified clu
Throws:: DoesNotExistException - cluId not found; InvalidParameterException - invalid contextInfo; MissingParameterException - missing cluId or contextInfo; OperationFailedException - unable to complete request

getCluPublicationsByType

public List<CluPublicationInfo> getCluPublicationsByType(String luPublicationTypeKey,
                                                         ContextInfo context)
                                                  throws DoesNotExistException,
                                                         InvalidParameterException,
                                                         MissingParameterException,
                                                         OperationFailedException

Description copied from interface: CluService

Retrieves a list of publication objects of a particular Type

Specified by:: getCluPublicationsByType in interface CluService

Parameters:: luPublicationTypeKey - luPublicationType identifier; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: list of CLU Publication objects using the specified type
Throws:: DoesNotExistException - luPublicationType not found; InvalidParameterException - invalid contextInfo; MissingParameterException - missing luPublicationTypeKey or contextInfo; OperationFailedException - unable to complete request

getCluPublication

public CluPublicationInfo getCluPublication(String cluPublicationId,
                                            ContextInfo context)
                                     throws DoesNotExistException,
                                            InvalidParameterException,
                                            MissingParameterException,
                                            OperationFailedException

Description copied from interface: CluService

Retrieves an LU publication object by its identifier

Specified by:: getCluPublication in interface CluService

Parameters:: cluPublicationId - CLU publication identifier; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: CLU Publication information
Throws:: DoesNotExistException - cluPublicationId not found; InvalidParameterException - invalid contextInfo; MissingParameterException - missing cluPublicationId or contextInfo; OperationFailedException - unable to complete request

getCluResult

public CluResultInfo getCluResult(String cluResultId,
                                  ContextInfo context)
                           throws DoesNotExistException,
                                  InvalidParameterException,
                                  MissingParameterException,
                                  OperationFailedException

Description copied from interface: CluService

Retrieves information about a Clu Result

Specified by:: getCluResult in interface CluService

Parameters:: cluResultId - identifier of the Clu Result; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: information about a Clu Result
Throws:: DoesNotExistException - cluResultId not found; InvalidParameterException - invalid contextInfo; MissingParameterException - missing cluResultId or contextInfo; OperationFailedException - unable to complete request

getCluResultByClu

public List<CluResultInfo> getCluResultByClu(String cluId,
                                             ContextInfo context)
                                      throws DoesNotExistException,
                                             InvalidParameterException,
                                             MissingParameterException,
                                             OperationFailedException

Description copied from interface: CluService

Retrieves the cluResult for a particular clu

Specified by:: getCluResultByClu in interface CluService

Parameters:: cluId - clu identifier; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: result information for a clu
Throws:: DoesNotExistException - cluId not found; InvalidParameterException - invalid contextInfo; MissingParameterException - missing cluId or contextInfo; OperationFailedException - unable to complete request

getCluIdsByResultUsageType

public List<String> getCluIdsByResultUsageType(String resultUsageTypeKey,
                                               ContextInfo context)
                                        throws DoesNotExistException,
                                               InvalidParameterException,
                                               MissingParameterException,
                                               OperationFailedException

Description copied from interface: CluService

Retrieves the list of clu Ids with the results of the specified usage type. This would for example allow requests for all clus which have a final grade.

Specified by:: getCluIdsByResultUsageType in interface CluService

Parameters:: resultUsageTypeKey - identifier of the result usage type; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: list of clu Ids
Throws:: DoesNotExistException - resultUsageType not found; InvalidParameterException - invalid resultUsageTypeKey; MissingParameterException - missing resultUsageTypeKey; OperationFailedException - unable to complete request

getCluIdsByResultComponent

public List<String> getCluIdsByResultComponent(String resultComponentId,
                                               ContextInfo context)
                                        throws DoesNotExistException,
                                               InvalidParameterException,
                                               MissingParameterException,
                                               OperationFailedException

Description copied from interface: CluService

Retrieves the list of clu Ids which use a particular result component

Specified by:: getCluIdsByResultComponent in interface CluService

Parameters:: resultComponentId - identifier of the result component; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: list of clu Ids
Throws:: DoesNotExistException - resultComponent not found; InvalidParameterException - invalid resultComponentId; MissingParameterException - missing resultComponentId; OperationFailedException - unable to complete request

getCluLoRelation

public CluLoRelationInfo getCluLoRelation(String cluLoRelationId,
                                          ContextInfo context)
                                   throws DoesNotExistException,
                                          InvalidParameterException,
                                          MissingParameterException,
                                          OperationFailedException,
                                          PermissionDeniedException

Description copied from interface: CluService

Retrieve information on a CLU LO Relation.

Specified by:: getCluLoRelation in interface CluService

Parameters:: cluLoRelationId - Identifier of the CLU LO Relation; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: The retrieved CLU LO Relation information
Throws:: DoesNotExistException - cluLoRelationId not found; InvalidParameterException - invalid contextInfo; MissingParameterException - missing cluLoRelationId or contextInfo; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

getCluLoRelationsByClu

public List<CluLoRelationInfo> getCluLoRelationsByClu(String cluId,
                                                      ContextInfo context)
                                               throws DoesNotExistException,
                                                      InvalidParameterException,
                                                      MissingParameterException,
                                                      OperationFailedException

Description copied from interface: CluService

Retrieves the list of canonical learning unit to learning objective relationships for a given CLU.

Specified by:: getCluLoRelationsByClu in interface CluService

Parameters:: cluId - Identifier for the CLU; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: List of canonical learning unit to learning objective relationships
Throws:: DoesNotExistException - cluId not found; InvalidParameterException - invalid contextInfo; MissingParameterException - missing cluId or contextInfo; OperationFailedException - unable to complete request

getCluLoRelationsByLo

public List<CluLoRelationInfo> getCluLoRelationsByLo(String loId,
                                                     ContextInfo context)
                                              throws DoesNotExistException,
                                                     InvalidParameterException,
                                                     MissingParameterException,
                                                     OperationFailedException

Description copied from interface: CluService

Retrieves the list of CLU identifiers associated with a given learning objective identifier.

Specified by:: getCluLoRelationsByLo in interface CluService

Parameters:: loId - Identifier for the learning objective; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: List of CLU LO Relations
Throws:: DoesNotExistException - loId not found; InvalidParameterException - invalid contextInfo; MissingParameterException - missing loId or contextInfo; OperationFailedException - unable to complete request

getResourceRequirementsForClu

public List<String> getResourceRequirementsForClu(String cluId,
                                                  ContextInfo context)
                                           throws DoesNotExistException,
                                                  InvalidParameterException,
                                                  MissingParameterException,
                                                  OperationFailedException

Description copied from interface: CluService

Retrieves the list of Resource requirements for the specified CLU

Specified by:: getResourceRequirementsForClu in interface CluService

Parameters:: cluId - Unique identifier for the CLU; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: List of resource requirements
Throws:: DoesNotExistException - cluId not found; InvalidParameterException - invalid contextInfo; MissingParameterException - missing cluId or contextInfo; OperationFailedException - unable to complete request

getCluSet

public CluSetInfo getCluSet(String cluSetId,
                            ContextInfo context)
                     throws DoesNotExistException,
                            InvalidParameterException,
                            MissingParameterException,
                            OperationFailedException,
                            PermissionDeniedException

Description copied from interface: CluService

Retrieve information on a CLU set. This information should be about the set itself, and in the case of a dynamic CLU set, should include the criteria used to generate the set.

Specified by:: getCluSet in interface CluService

Parameters:: cluSetId - Identifier of the CLU set; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: The retrieved CLU set information
Throws:: DoesNotExistException - cluSetId not found; InvalidParameterException - invalid contextInfo; MissingParameterException - missing cluSetId or contextInfo; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

getCluSetTreeView

public CluSetTreeViewInfo getCluSetTreeView(String cluSetId,
                                            ContextInfo context)
                                     throws DoesNotExistException,
                                            InvalidParameterException,
                                            MissingParameterException,
                                            OperationFailedException,
                                            PermissionDeniedException

Description copied from interface: CluService

Retrieve information on a CLU set and its sub clu set fully expanded.

Specified by:: getCluSetTreeView in interface CluService

Parameters:: cluSetId - Identifier of the CLU set; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: The retrieved CLU set tree view information
Throws:: DoesNotExistException - cluSetId not found; InvalidParameterException - invalid contextInfo; MissingParameterException - missing cluSetId or contextInfo; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

getCluSetsByIds

public List<CluSetInfo> getCluSetsByIds(List<String> cluSetIds,
                                        ContextInfo context)
                                 throws DoesNotExistException,
                                        InvalidParameterException,
                                        MissingParameterException,
                                        OperationFailedException,
                                        PermissionDeniedException

Description copied from interface: CluService

Retrieve information on CLU sets from a list of cluSet Ids.

Specified by:: getCluSetsByIds in interface CluService

Parameters:: cluSetIds - List of identifiers of CLU sets; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: The retrieved list of CLU set information
Throws:: DoesNotExistException - One or more cluSets not found; InvalidParameterException - invalid contextInfo; MissingParameterException - missing cluSetIds or contextInfo; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

getCluSetIdsFromCluSet

public List<String> getCluSetIdsFromCluSet(String cluSetId,
                                           ContextInfo context)
                                    throws DoesNotExistException,
                                           InvalidParameterException,
                                           MissingParameterException,
                                           OperationFailedException,
                                           PermissionDeniedException

Description copied from interface: CluService

Retrieve the list of CLU Set Ids within a CLU Set

Specified by:: getCluSetIdsFromCluSet in interface CluService

Parameters:: cluSetId - Identifier of the CLU set; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: The retrieved list of CLU Set Ids within the specified CLU set
Throws:: DoesNotExistException - cluSet not found; InvalidParameterException - invalid contextInfo; MissingParameterException - missing cluSetId or contextInfo; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

isCluSetDynamic

public Boolean isCluSetDynamic(String cluSetId,
                               ContextInfo context)
                        throws DoesNotExistException,
                               InvalidParameterException,
                               MissingParameterException,
                               OperationFailedException,
                               PermissionDeniedException

Description copied from interface: CluService

Check if the given CluSet is dynamic

Specified by:: isCluSetDynamic in interface CluService

Parameters:: cluSetId - Identifier of the CLU set; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: The retrieved list of CLU Set Ids within the specified CLU set
Throws:: DoesNotExistException - cluSetId not found; InvalidParameterException - invalid contextInfo; MissingParameterException - missing cluSetId or contextInfo; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

getClusFromCluSet

public List<CluInfo> getClusFromCluSet(String cluSetId,
                                       ContextInfo context)
                                throws DoesNotExistException,
                                       InvalidParameterException,
                                       MissingParameterException,
                                       OperationFailedException,
                                       PermissionDeniedException

Description copied from interface: CluService

Retrieves the list of CLUs in a CLU set. This only retrieves the direct members.

Specified by:: getClusFromCluSet in interface CluService

Parameters:: cluSetId - Identifier of the CLU set; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: The retrieved list of information on the CLUs within the CLU set (flattened and de-duped)
Throws:: DoesNotExistException - cluSetId not found; InvalidParameterException - invalid contextInfo; MissingParameterException - missing cluSetId or contextInfo; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

getCluIdsFromCluSet

public List<String> getCluIdsFromCluSet(String cluSetId,
                                        ContextInfo context)
                                 throws DoesNotExistException,
                                        InvalidParameterException,
                                        MissingParameterException,
                                        OperationFailedException,
                                        PermissionDeniedException

Description copied from interface: CluService

Retrieves the list of CLU Identifiers within a CLU Set. This only retrieves the direct members.

Specified by:: getCluIdsFromCluSet in interface CluService

Parameters:: cluSetId - Identifier of the CLU set; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: The retrieved list of CLU Ids within the specified CLU set (flattened and de-duped)
Throws:: DoesNotExistException - cluSetId not found; InvalidParameterException - invalid contextInfo; MissingParameterException - missing cluSetId or contextInfo; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

getAllClusInCluSet

public List<CluInfo> getAllClusInCluSet(String cluSetId,
                                        ContextInfo context)
                                 throws DoesNotExistException,
                                        InvalidParameterException,
                                        MissingParameterException,
                                        OperationFailedException,
                                        PermissionDeniedException

Description copied from interface: CluService

Retrieves the full list of CLUs in this CLU set or any cluset that is included within that.

Specified by:: getAllClusInCluSet in interface CluService

Parameters:: cluSetId - Identifier of the CLU set; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: The retrieved list of information on the CLUs
Throws:: DoesNotExistException - cluSet not found; InvalidParameterException - invalid contextInfo; MissingParameterException - missing cluSetId or contextInfo; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

getAllCluIdsInCluSet

public List<String> getAllCluIdsInCluSet(String cluSetId,
                                         ContextInfo context)
                                  throws DoesNotExistException,
                                         InvalidParameterException,
                                         MissingParameterException,
                                         OperationFailedException,
                                         PermissionDeniedException

Description copied from interface: CluService

Retrieves the list of CLU Identifiers within a CLU Set or any cluset that is included within that.

Specified by:: getAllCluIdsInCluSet in interface CluService

Parameters:: cluSetId - Identifier of the CLU set; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: The retrieved list of CLU Ids within the specified CLU set
Throws:: DoesNotExistException - cluSetId not found; InvalidParameterException - invalid contextInfo; MissingParameterException - missing cluSetId or contextInfo; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

isCluInCluSet

public Boolean isCluInCluSet(String cluId,
                             String cluSetId,
                             ContextInfo context)
                      throws DoesNotExistException,
                             InvalidParameterException,
                             MissingParameterException,
                             OperationFailedException,
                             PermissionDeniedException

Description copied from interface: CluService

Checks if a CLU is a member of a CLU set or any contained CLU set

Specified by:: isCluInCluSet in interface CluService

Parameters:: cluId - Identifier of the CLU to check; cluSetId - Identifier of the CLU set; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: True if the CLU is a member of the CLU Set
Throws:: DoesNotExistException - cluId, cluSetId not found; InvalidParameterException - invalid contextInfo; MissingParameterException - missing cluId, cluSetId or contextInfo; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

validateClu

public List<ValidationResultInfo> validateClu(String validationType,
                                              CluInfo cluInfo,
                                              ContextInfo context)
                                       throws DoesNotExistException,
                                              InvalidParameterException,
                                              MissingParameterException,
                                              OperationFailedException

MAINTENANCE OPERATIONS *

Specified by:: validateClu in interface CluService

Parameters:: validationType - identifier of the extent of validation; cluInfo - CLU information to be tested.; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: results from performing the validation
Throws:: DoesNotExistException - validationTypeKey not found; InvalidParameterException - invalid cluInfo or contextInfo; MissingParameterException - missing validationTypeKey, cluInfo or contextInfo; OperationFailedException - unable to complete request

createClu

@Transactional(readOnly=false)
public CluInfo createClu(String luTypeKey,
                                               CluInfo cluInfo,
                                               ContextInfo context)
                  throws DataValidationErrorException,
                         DoesNotExistException,
                         InvalidParameterException,
                         MissingParameterException,
                         OperationFailedException,
                         PermissionDeniedException

Description copied from interface: CluService

Creates a new CLU

Specified by:: createClu in interface CluService

Parameters:: luTypeKey - identifier of the LU Type for the CLU being created; cluInfo - information about the CLU being created; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: the created CLU information
Throws:: DataValidationErrorException - supplied data is invalid; DoesNotExistException - luTypeKey not found; InvalidParameterException - invalid cluInfo or contextInfo; MissingParameterException - missing luTypeKey, cluInfo; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

toCluForCreate

public Clu toCluForCreate(String luTypeKey,
                          CluInfo cluInfo,
                          ContextInfo context)
                   throws AlreadyExistsException,
                          DataValidationErrorException,
                          DoesNotExistException,
                          InvalidParameterException,
                          MissingParameterException,
                          OperationFailedException,
                          PermissionDeniedException

Throws:: AlreadyExistsException; DataValidationErrorException; DoesNotExistException; InvalidParameterException; MissingParameterException; OperationFailedException; PermissionDeniedException

updateClu

@Transactional(readOnly=false)
public CluInfo updateClu(String cluId,
                                               CluInfo cluInfo,
                                               ContextInfo context)
                  throws DataValidationErrorException,
                         DoesNotExistException,
                         InvalidParameterException,
                         MissingParameterException,
                         OperationFailedException,
                         PermissionDeniedException,
                         VersionMismatchException

Description copied from interface: CluService

Updates an existing CLU

Specified by:: updateClu in interface CluService

Parameters:: cluId - identifier for the CLU to be updated; cluInfo - updated information about the CLU; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: the updated CLU information
Throws:: DataValidationErrorException - supplied data is invalid; DoesNotExistException - cluId not found; InvalidParameterException - invalid cluInfo or contextInfo; MissingParameterException - missing cluId, cluInfo or contextInfo; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure; VersionMismatchException - an optimistic locking failure or the action was attempted on an out of date version

deleteClu

@Transactional(readOnly=false)
public StatusInfo deleteClu(String cluId,
                                                  ContextInfo context)
                     throws DoesNotExistException,
                            InvalidParameterException,
                            MissingParameterException,
                            DependentObjectsExistException,
                            OperationFailedException,
                            PermissionDeniedException

Description copied from interface: CluService

Deletes an existing CLU

Specified by:: deleteClu in interface CluService

Parameters:: cluId - identifier for the CLU to be deleted; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: status of the operation
Throws:: DoesNotExistException - cluId not found; InvalidParameterException - invalid contextInfo; MissingParameterException - missing cluId or contextInfo; DependentObjectsExistException - delete would leave orphaned objects or violate integrity constraints; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

updateCluState

@Transactional(readOnly=false)
public CluInfo updateCluState(String cluId,
                                                    String luState,
                                                    ContextInfo context)
                       throws DataValidationErrorException,
                              DoesNotExistException,
                              InvalidParameterException,
                              MissingParameterException,
                              OperationFailedException,
                              PermissionDeniedException

Description copied from interface: CluService

Updates the state of the specified CLU

Specified by:: updateCluState in interface CluService

Parameters:: cluId - identifier for the CLU to be updated; luState - new state for the CLU. Value is expected to be constrained to those in the luState enumeration.; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: the updated CLU information
Throws:: DataValidationErrorException - supplied data is invalid; DoesNotExistException - cluId not found; InvalidParameterException - invalid contextInfo; MissingParameterException - missing cluId, luState or contextInfo; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

validateCluCluRelation

public List<ValidationResultInfo> validateCluCluRelation(String validationTypeKey,
                                                         String cluId,
                                                         String relatedCluId,
                                                         String cluCluRelationTypeKey,
                                                         CluCluRelationInfo cluCluRelationInfo,
                                                         ContextInfo contextInfo)
                                                  throws DoesNotExistException,
                                                         InvalidParameterException,
                                                         MissingParameterException,
                                                         OperationFailedException,
                                                         PermissionDeniedException

Description copied from interface: CluService

Validates a cluCluRelation. Depending on the value of validationType, this validation could be limited to tests on just the current object and its directly contained sub-objects or expanded to perform all tests related to this object. If an identifier is present for the cluCluRelation (and/or one of its contained sub-objects) and a record is found for that identifier, the validation checks if the relationship can be shifted to the new values. If an identifier is not present or a record cannot be found for the identifier, it is assumed that the record does not exist and as such, the checks performed will be much shallower, typically mimicking those performed by setting the validationType to the current object.

Specified by:: validateCluCluRelation in interface CluService

Parameters:: validationTypeKey - identifier of the extent of validation; cluId - identifier of the first CLU in the relationship - The From or Parent of the relation; relatedCluId - identifier of the second CLU in the relationship to be related to - the To or Child of the Relation; cluCluRelationTypeKey - the CLU to CLU relationship type of the relationship; cluCluRelationInfo - cluCluRelation information to be tested.; contextInfo - Context information containing the principalId and locale information about the caller of service operation
Returns:: results from performing the validation
Throws:: DoesNotExistException - validationTypeKey, cluId, relatedCluId or cluCluRelationTypeKey not found; InvalidParameterException - invalid cluCluRelationInfo or contextInfo; MissingParameterException - missing validationTypeKey, cluId, relatedCluId, cluCluRelationTypeKey or cluCluRelationInfo or contextInfo; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

createCluCluRelation

@Transactional(readOnly=false)
public CluCluRelationInfo createCluCluRelation(String cluId,
                                                                     String relatedCluId,
                                                                     String luLuRelationTypeKey,
                                                                     CluCluRelationInfo cluCluRelationInfo,
                                                                     ContextInfo context)
                                        throws DataValidationErrorException,
                                               DoesNotExistException,
                                               InvalidParameterException,
                                               MissingParameterException,
                                               OperationFailedException,
                                               PermissionDeniedException,
                                               CircularRelationshipException

Description copied from interface: CluService

Create a directional relationship between two CLUs

Specified by:: createCluCluRelation in interface CluService

Parameters:: cluId - identifier of the first CLU in the relationship - The From or Parent of the relation; relatedCluId - identifier of the second CLU in the relationship to be related to - the To or Child of the Relation; luLuRelationTypeKey - the LU to LU relationship type of the relationship; cluCluRelationInfo - information about the relationship between the two CLUs; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: the created CLU to CLU relation information
Throws:: DataValidationErrorException - One or more values invalid for this operation; DoesNotExistException - cluId, relatedCluId, cluCluRelationTypeKey not found; InvalidParameterException - invalid cluCluRelationInfo or contextInfo; MissingParameterException - missing cluId, relatedCluId, cluCluRelationTypeKey, cluCluRelationInfo or contextInfo; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure; CircularRelationshipException - cluId equals relatedCluId

updateCluCluRelation

@Transactional(readOnly=false)
public CluCluRelationInfo updateCluCluRelation(String cluCluRelationId,
                                                                     CluCluRelationInfo cluCluRelationInfo,
                                                                     ContextInfo context)
                                        throws DataValidationErrorException,
                                               DoesNotExistException,
                                               InvalidParameterException,
                                               MissingParameterException,
                                               OperationFailedException,
                                               PermissionDeniedException,
                                               VersionMismatchException

Description copied from interface: CluService

Updates a relationship between two CLUs

Specified by:: updateCluCluRelation in interface CluService

Parameters:: cluCluRelationId - identifier of the CLU to CLU relation to be updated; cluCluRelationInfo - changed information about the CLU to CLU relationship; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: the updated CLU to CLU relation information
Throws:: DataValidationErrorException - One or more values invalid for this operation; DoesNotExistException - cluCluRelation not found; InvalidParameterException - invalid cluCluRelationInfo or contextInfo; MissingParameterException - missing cluCluRelationId, cluCluRelationInfo or contextInfo; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure; VersionMismatchException - an optimistic locking failure or the action was attempted on an out of date version

deleteCluCluRelation

@Transactional(readOnly=false)
public StatusInfo deleteCluCluRelation(String cluCluRelationId,
                                                             ContextInfo context)
                                throws DoesNotExistException,
                                       InvalidParameterException,
                                       MissingParameterException,
                                       OperationFailedException,
                                       PermissionDeniedException

Description copied from interface: CluService

Deletes a relationship between two CLUs

Specified by:: deleteCluCluRelation in interface CluService

Parameters:: cluCluRelationId - identifier of CLU to CLU relationship to delete; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: status of the operation (success or failure)
Throws:: DoesNotExistException - cluCluRelationId not found; InvalidParameterException - invalid contextInfo; MissingParameterException - missing cluCluRelationId or contextInfo; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

validateCluPublication

public List<ValidationResultInfo> validateCluPublication(String validationType,
                                                         String cluId,
                                                         String luPublicationTypeKey,
                                                         CluPublicationInfo cluPublicationInfo,
                                                         ContextInfo context)
                                                  throws DoesNotExistException,
                                                         InvalidParameterException,
                                                         MissingParameterException,
                                                         OperationFailedException

Description copied from interface: CluService

Validates information about publication for a clu. Depending on the value of validationTypeKey, this validation could be limited to tests on just the current object and its directly contained sub-objects or expanded to perform all tests related to this object. If an identifier is present for the clu publication object (and/or one of its contained sub-objects) and a record is found for that identifier, the validation checks if the clu publication object can be shifted to the new values. If an identifier is not present or a record cannot be found for the identifier, it is assumed that the record does not exist and as such, the checks performed will be much shallower, typically mimicking those performed by setting the validationTypeKey to the current object.

Specified by:: validateCluPublication in interface CluService

Parameters:: validationType - identifier of the extent of validation; cluId - identifier of a clu; luPublicationTypeKey - type of lu publication; cluPublicationInfo - CLU publication information to be tested.; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: results from performing the validation
Throws:: DoesNotExistException - validationTypeKey, cluId or luPublicationTypeKey not found; InvalidParameterException - invalid cluPublicationInfo or contextInfo; MissingParameterException - missing validationTypeKey, cluId, luPublicationTypeKey, cluPublicationInfo or contextInfo; OperationFailedException - unable to complete request

createCluPublication

@Transactional(readOnly=false)
public CluPublicationInfo createCluPublication(String cluId,
                                                                     String luPublicationType,
                                                                     CluPublicationInfo cluPublicationInfo,
                                                                     ContextInfo context)
                                        throws DataValidationErrorException,
                                               InvalidParameterException,
                                               MissingParameterException,
                                               OperationFailedException,
                                               PermissionDeniedException

Description copied from interface: CluService

Create a clu publication object, which contains information about publication for a clu.

Specified by:: createCluPublication in interface CluService

Parameters:: cluId - identifier of a clu; luPublicationType - type of lu publication; cluPublicationInfo - information about publication for a clu; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: information about the created clu publication object
Throws:: DataValidationErrorException - supplied data is invalid; InvalidParameterException - invalid cluPublicationInfo or contextInfo; MissingParameterException - missing cluId, luPublicationTypeKey, cluPublicationInfo or contextInfo; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

updateCluPublication

@Transactional(readOnly=false)
public CluPublicationInfo updateCluPublication(String cluPublicationId,
                                                                     CluPublicationInfo cluPublicationInfo,
                                                                     ContextInfo context)
                                        throws DataValidationErrorException,
                                               DoesNotExistException,
                                               InvalidParameterException,
                                               MissingParameterException,
                                               OperationFailedException,
                                               PermissionDeniedException,
                                               VersionMismatchException

Description copied from interface: CluService

Updates an existing clu publication object

Specified by:: updateCluPublication in interface CluService

Parameters:: cluPublicationId - identifier for the clu publication object to be updated; cluPublicationInfo - updated information about the clu publication object; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: the updated clu publication information
Throws:: DataValidationErrorException - supplied data is invalid; DoesNotExistException - cluPublicationId not found; InvalidParameterException - invalid cluPublicationInfo or contextInfo; MissingParameterException - missing cluPublicationId, cluPublicationInfo or contextInfo; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure; VersionMismatchException - The action was attempted on an out of date version.

deleteCluPublication

@Transactional(readOnly=false)
public StatusInfo deleteCluPublication(String cluPublicationId,
                                                             ContextInfo context)
                                throws DoesNotExistException,
                                       InvalidParameterException,
                                       MissingParameterException,
                                       DependentObjectsExistException,
                                       OperationFailedException,
                                       PermissionDeniedException

Description copied from interface: CluService

Deletes an existing clu publication object

Specified by:: deleteCluPublication in interface CluService

Parameters:: cluPublicationId - identifier for the clu publication object to be deleted; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: status of the operation
Throws:: DoesNotExistException - cluPublicationId not found; InvalidParameterException - invalid contextInfo; MissingParameterException - missing cluPublicationId or contextInfo; DependentObjectsExistException - delete would leave orphaned objects or violate integrity constraints; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

validateCluResult

public List<ValidationResultInfo> validateCluResult(String validationType,
                                                    String cluId,
                                                    String cluResultTypeKey,
                                                    CluResultInfo cluResultInfo,
                                                    ContextInfo context)
                                             throws DoesNotExistException,
                                                    InvalidParameterException,
                                                    MissingParameterException,
                                                    OperationFailedException

Description copied from interface: CluService

Validates information about results for a clu. Depending on the value of validationTypeKey, this validation could be limited to tests on just the current object and its directly contained sub-objects or expanded to perform all tests related to this object. If an identifier is present for the clu result object (and/or one of its contained sub-objects) and a record is found for that identifier, the validation checks if the clu result object can be shifted to the new values. If an identifier is not present or a record cannot be found for the identifier, it is assumed that the record does not exist and as such, the checks performed will be much shallower, typically mimicking those performed by setting the validationTypeKey to the current object.

Specified by:: validateCluResult in interface CluService

Parameters:: validationType - identifier of the extent of validation; cluId - identifier of a clu; cluResultTypeKey - type of clu result; cluResultInfo - CLU result information to be tested.; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: results from performing the validation
Throws:: DoesNotExistException - validationTypeKey, cluId or cluResultTypeKey not found; InvalidParameterException - invalid cluResultInfo or contextInfo; MissingParameterException - missing validationTypeKey, cluId, cluResultTypeKey, cluResultInfo or contextInfo; OperationFailedException - unable to complete request

createCluResult

@Transactional(readOnly=false)
public CluResultInfo createCluResult(String cluId,
                                                           String cluResultTypeKey,
                                                           CluResultInfo cluResultInfo,
                                                           ContextInfo context)
                              throws DataValidationErrorException,
                                     InvalidParameterException,
                                     MissingParameterException,
                                     OperationFailedException,
                                     PermissionDeniedException,
                                     DoesNotExistException

Description copied from interface: CluService

Create a clu result object, which contains information about potential results for a clu.

Specified by:: createCluResult in interface CluService

Parameters:: cluId - identifier of a clu; cluResultTypeKey - type of clu result; cluResultInfo - information about potential results for a clu; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: information about the created clu result
Throws:: DataValidationErrorException - supplied data is invalid; InvalidParameterException - invalid cluResultInfo or contextInfo; MissingParameterException - missing cluId, cluResultTypeKey, cluResultInfo or contextInfo; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure; DoesNotExistException - cluId or resultUsageTypeKey not found

updateCluResult

@Transactional(readOnly=false)
public CluResultInfo updateCluResult(String cluResultId,
                                                           CluResultInfo cluResultInfo,
                                                           ContextInfo context)
                              throws DataValidationErrorException,
                                     DoesNotExistException,
                                     InvalidParameterException,
                                     MissingParameterException,
                                     OperationFailedException,
                                     PermissionDeniedException,
                                     VersionMismatchException

Description copied from interface: CluService

Updates an existing clu result

Specified by:: updateCluResult in interface CluService

Parameters:: cluResultId - identifier for the clu result to be updated; cluResultInfo - updated information about the clu result; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: the updated clu result information
Throws:: DataValidationErrorException - One or more values invalid for this operation; DoesNotExistException - cluResultId not found; InvalidParameterException - invalid contextInfo; MissingParameterException - missing cluResultId, cluResultInfo or contextInfo; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure; VersionMismatchException - an optimistic locking failure or the action was attempted on an out of date version

deleteCluResult

@Transactional(readOnly=false)
public StatusInfo deleteCluResult(String cluResultId,
                                                        ContextInfo context)
                           throws DoesNotExistException,
                                  InvalidParameterException,
                                  MissingParameterException,
                                  DependentObjectsExistException,
                                  OperationFailedException,
                                  PermissionDeniedException

Description copied from interface: CluService

Deletes an existing clu result

Specified by:: deleteCluResult in interface CluService

Parameters:: cluResultId - identifier for the clu result to be deleted; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: status of the operation
Throws:: DoesNotExistException - cluResultId not found; InvalidParameterException - invalid contextInfo; MissingParameterException - missing cluResultId or contextInfo; DependentObjectsExistException - delete would leave orphaned objects or violate integrity constraints; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

validateCluLoRelation

public List<ValidationResultInfo> validateCluLoRelation(String validationType,
                                                        String cluId,
                                                        String loId,
                                                        String cluLoRelationType,
                                                        CluLoRelationInfo cluLoRelationInfo,
                                                        ContextInfo context)
                                                 throws DoesNotExistException,
                                                        InvalidParameterException,
                                                        MissingParameterException,
                                                        OperationFailedException

Description copied from interface: CluService

Validates a cluLoRelation. Depending on the value of validationTypeKey, this validation could be limited to tests on just the current object and its directly contained sub-objects or expanded to perform all tests related to this object. If an identifier is present for the cluLoRelation (and/or one of its contained sub-objects) and a record is found for that identifier, the validation checks if the relationship can be shifted to the new values. If an identifier is not present or a record cannot be found for the identifier, it is assumed that the record does not exist and as such, the checks performed will be much shallower, typically mimicking those performed by setting the validationTypeKey to the current object.

Specified by:: validateCluLoRelation in interface CluService

Parameters:: validationType - identifier of the extent of validation; cluId - CLU identifier; loId - learning objective identifier; cluLoRelationType - type of clu learning objective relationship; cluLoRelationInfo - cluLoRelation information to be tested.; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: results from performing the validation
Throws:: DoesNotExistException - validationTypeKey, cluId, loId or cluLoRelationTypeKey not found; InvalidParameterException - invalid cluLoRelationInfo or contextInfo; MissingParameterException - missing validationTypeKey, cluId, loId, cluLoRelationTypeKey, cluLoRelationInfo or contextInfo; OperationFailedException - unable to complete request

createCluLoRelation

@Transactional(readOnly=false)
public CluLoRelationInfo createCluLoRelation(String cluId,
                                                                   String loId,
                                                                   String cluLoRelationType,
                                                                   CluLoRelationInfo cluLoRelationInfo,
                                                                   ContextInfo context)
                                      throws DoesNotExistException,
                                             InvalidParameterException,
                                             MissingParameterException,
                                             OperationFailedException,
                                             PermissionDeniedException,
                                             DataValidationErrorException

Description copied from interface: CluService

Creates a relationship between a learning objective and a CLU.

Specified by:: createCluLoRelation in interface CluService

Parameters:: cluId - CLU identifier; loId - learning objective identifier; cluLoRelationType - type of clu learning objective relationship; cluLoRelationInfo - clu learning objective relationship information; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: the newly created clu learning objective relationship
Throws:: DoesNotExistException - cluId, loId, cluLoRelationTypeKey not found; InvalidParameterException - invalid cluLoRelationInfo or contextInfo; MissingParameterException - missing cluId, loId, cluLoRelationTypeKey, cluLoRelationInfo or contextInfo; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure; DataValidationErrorException - data validation error

updateCluLoRelation

@Transactional(readOnly=false)
public CluLoRelationInfo updateCluLoRelation(String cluLoRelationId,
                                                                   CluLoRelationInfo cluLoRelationInfo,
                                                                   ContextInfo context)
                                      throws DataValidationErrorException,
                                             DoesNotExistException,
                                             InvalidParameterException,
                                             MissingParameterException,
                                             OperationFailedException,
                                             PermissionDeniedException,
                                             VersionMismatchException

Description copied from interface: CluService

Updates a relationship between a clu and learning objective

Specified by:: updateCluLoRelation in interface CluService

Parameters:: cluLoRelationId - identifier of the clu learning objective relationship to be updated; cluLoRelationInfo - information about the clu learning objective relationship to be updated; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: the updated clu learning objective relationship information
Throws:: DataValidationErrorException - data validation error; DoesNotExistException - cluLoRelationId not found; InvalidParameterException - invalid cluLoRelationInfo or contextInfo; MissingParameterException - missing cluLoRelationId, cluLoRelationInfo or contextInfo; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure; VersionMismatchException - The action was attempted on an out of date version.

deleteCluLoRelation

@Transactional(readOnly=false)
public StatusInfo deleteCluLoRelation(String cluLoRelationId,
                                                            ContextInfo context)
                               throws DoesNotExistException,
                                      InvalidParameterException,
                                      MissingParameterException,
                                      OperationFailedException,
                                      PermissionDeniedException

Description copied from interface: CluService

Removes a relationship between a learning objective and a Clu.

Specified by:: deleteCluLoRelation in interface CluService

Parameters:: cluLoRelationId - CLU learning objective Relationship identifier; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: Status of the delete operation
Throws:: DoesNotExistException - cluLoRelationId not found; InvalidParameterException - invalid contextInfo; MissingParameterException - missing cluLoRelationId; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

addCluResourceRequirement

@Transactional(readOnly=false)
public StatusInfo addCluResourceRequirement(String resourceTypeKey,
                                                                  String cluId,
                                                                  ContextInfo context)
                                     throws AlreadyExistsException,
                                            DoesNotExistException,
                                            InvalidParameterException,
                                            MissingParameterException,
                                            OperationFailedException,
                                            PermissionDeniedException

Description copied from interface: CluService

Add a Resource requirement to a CLU

Specified by:: addCluResourceRequirement in interface CluService

Parameters:: resourceTypeKey - identifier of the resource requirement type to be added to the CLU; cluId - identifier of the CLU; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: status of the operation (success or failure)
Throws:: AlreadyExistsException - if the resource type has already been added to the clu; DoesNotExistException - resourceTypeKey or cluId not found; InvalidParameterException - invalid resourceTypeKey or cluId; MissingParameterException - missing resourceTypeKey, cluId or contextInfo; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

removeCluResourceRequirement

@Transactional(readOnly=false)
public StatusInfo removeCluResourceRequirement(String resourceTypeKey,
                                                                     String cluId,
                                                                     ContextInfo context)
                                        throws DoesNotExistException,
                                               InvalidParameterException,
                                               MissingParameterException,
                                               OperationFailedException,
                                               PermissionDeniedException

Description copied from interface: CluService

Remove a Resource requirement from a CLU

Specified by:: removeCluResourceRequirement in interface CluService

Parameters:: resourceTypeKey - identifier of the resource type to be removed from the CLU; cluId - identifier of the CLU; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: status of the operation (success or failure)
Throws:: DoesNotExistException - resourceTypeKey or cluId not found; InvalidParameterException - invalid contextInfo; MissingParameterException - missing resourceTypeKey, cluId or contextInfo; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

validateCluSet

public List<ValidationResultInfo> validateCluSet(String validationType,
                                                 String cluSetType,
                                                 CluSetInfo cluSetInfo,
                                                 ContextInfo context)
                                          throws DoesNotExistException,
                                                 InvalidParameterException,
                                                 MissingParameterException,
                                                 OperationFailedException

Description copied from interface: CluService

Validates information about a clu set. Depending on the value of validationTypeKey, this validation could be limited to tests on just the current object and its directly contained sub-objects or expanded to perform all tests related to this object. If an identifier is present for the clu set (and/or one of its contained sub-objects) and a record is found for that identifier, the validation checks if the clu set can be shifted to the new values. If an identifier is not present or a record cannot be found for the identifier, it is assumed that the record does not exist and as such, the checks performed will be much shallower, typically mimicking those performed by setting the validationType to the current object.

Specified by:: validateCluSet in interface CluService

Parameters:: validationType - identifier of the extent of validation; cluSetType - type of the CLU set to be created; cluSetInfo - CLU set information to be tested.; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: results from performing the validation
Throws:: DoesNotExistException - validationTypeKey or cluSetTypeKey not found; InvalidParameterException - invalid cluSetInfo or contextInfo; MissingParameterException - missing validationTypeKey, cluSetTypeKey, cluSetInfo or contextInfo; OperationFailedException - unable to complete request

createCluSet

@Transactional(readOnly=false)
public CluSetInfo createCluSet(String cluSetType,
                                                     CluSetInfo cluSetInfo,
                                                     ContextInfo context)
                        throws DataValidationErrorException,
                               InvalidParameterException,
                               MissingParameterException,
                               OperationFailedException,
                               PermissionDeniedException,
                               UnsupportedActionException

Description copied from interface: CluService

Creates a CLU set.

Specified by:: createCluSet in interface CluService

Parameters:: cluSetType - type of the CLU set to be created; cluSetInfo - information required to create a CLU set; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: the created CLU set information
Throws:: DataValidationErrorException - data validation error; InvalidParameterException - invalid cluSetInfo or contextInfo; MissingParameterException - missing cluSetTypeKey, cluSetInfo or contextInfo; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure; UnsupportedActionException - CLU set need to be static or dynamic but not both

updateCluSet

@Transactional(readOnly=false)
public CluSetInfo updateCluSet(String cluSetId,
                                                     CluSetInfo cluSetInfo,
                                                     ContextInfo context)
                        throws DataValidationErrorException,
                               DoesNotExistException,
                               InvalidParameterException,
                               MissingParameterException,
                               OperationFailedException,
                               PermissionDeniedException,
                               VersionMismatchException,
                               CircularRelationshipException,
                               UnsupportedActionException

Description copied from interface: CluService

Update the information for a CLU set

Specified by:: updateCluSet in interface CluService

Parameters:: cluSetId - identifier of the CLU set to be updated; cluSetInfo - updated information about the CLU set; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: the updated CLU set information
Throws:: DataValidationErrorException - data validation error; DoesNotExistException - cluSetId not found; InvalidParameterException - invalid cluSetInfo or contextInfo; MissingParameterException - missing cluSetId, cluSetInfo or contextInfo; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure; VersionMismatchException - an optimistic locking failure or the action was attempted on an out of date version; CircularRelationshipException - added CluSetId cannot be added to the cluSetInfo; UnsupportedActionException - CLU set need to be static or dynamic but not both

deleteCluSet

@Transactional(readOnly=false)
public StatusInfo deleteCluSet(String cluSetId,
                                                     ContextInfo context)
                        throws DoesNotExistException,
                               InvalidParameterException,
                               MissingParameterException,
                               OperationFailedException,
                               PermissionDeniedException

Description copied from interface: CluService

Delete a CLU set

Specified by:: deleteCluSet in interface CluService

Parameters:: cluSetId - identifier of the CLU set to be deleted; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: status of the operation (success or failure)
Throws:: DoesNotExistException - cluSetId not found; InvalidParameterException - invalid contextInfo; MissingParameterException - missing cluSetId or contextInfo; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

addCluSetToCluSet

@Transactional(readOnly=false)
public StatusInfo addCluSetToCluSet(String cluSetId,
                                                          String addedCluSetId,
                                                          ContextInfo context)
                             throws DoesNotExistException,
                                    InvalidParameterException,
                                    MissingParameterException,
                                    OperationFailedException,
                                    PermissionDeniedException,
                                    UnsupportedActionException,
                                    CircularRelationshipException

Description copied from interface: CluService

Adds one CLU set to another

Specified by:: addCluSetToCluSet in interface CluService

Parameters:: cluSetId - identifier of the host CLU set; addedCluSetId - identifier of the CLU set to be added; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: status of the operation (success or failure)
Throws:: DoesNotExistException - cluSetId, addedCluSetId not found; InvalidParameterException - invalid contextInfo; MissingParameterException - missing cluSetId, addedCluSetId or contextInfo; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure; UnsupportedActionException - CLU set is dynamically determined; CircularRelationshipException - addedCluSetId cannot be added to the CluSetId

removeCluSetFromCluSet

@Transactional(readOnly=false)
public StatusInfo removeCluSetFromCluSet(String cluSetId,
                                                               String removedCluSetId,
                                                               ContextInfo context)
                                  throws DoesNotExistException,
                                         InvalidParameterException,
                                         MissingParameterException,
                                         OperationFailedException,
                                         PermissionDeniedException,
                                         UnsupportedActionException

Description copied from interface: CluService

Removes one CLU set from another

Specified by:: removeCluSetFromCluSet in interface CluService

Parameters:: cluSetId - identifier of the host CLU set; removedCluSetId - identifier of the CLU set to be removed; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: status of the operation (success or failure)
Throws:: DoesNotExistException - cluSetId, removedCluSetId not found; InvalidParameterException - invalid contextInfo; MissingParameterException - missing cluSetId, removedCluSetId or contextInfo; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure; UnsupportedActionException - CLU set is dynamically determined

addCluToCluSet

@Transactional(readOnly=false)
public StatusInfo addCluToCluSet(String cluId,
                                                       String cluSetId,
                                                       ContextInfo context)
                          throws DoesNotExistException,
                                 InvalidParameterException,
                                 MissingParameterException,
                                 OperationFailedException,
                                 PermissionDeniedException,
                                 UnsupportedActionException

Description copied from interface: CluService

Add a CLU to a CLU set

Specified by:: addCluToCluSet in interface CluService

Parameters:: cluId - identifier of CLU to add to the CLU set; cluSetId - identifier of the CLU set; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: status of the operation (success or failure)
Throws:: DoesNotExistException - cluId, cluSetId not found; InvalidParameterException - invalid contextInfo; MissingParameterException - missing cluId, cluSetId or contextInfo; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure; UnsupportedActionException - CLU set is dynamically determined

removeCluFromCluSet

@Transactional(readOnly=false)
public StatusInfo removeCluFromCluSet(String cluId,
                                                            String cluSetId,
                                                            ContextInfo context)
                               throws DoesNotExistException,
                                      InvalidParameterException,
                                      MissingParameterException,
                                      OperationFailedException,
                                      PermissionDeniedException,
                                      UnsupportedActionException

Description copied from interface: CluService

Remove a CLU from a CLU set

Specified by:: removeCluFromCluSet in interface CluService

Parameters:: cluId - identifier of CLU to remove from the CLU set; cluSetId - identifier of the CLU set; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: status of the operation (success or failure)
Throws:: DoesNotExistException - cluId, cluSetId not found; InvalidParameterException - invalid contextInfo; MissingParameterException - missing cluId, cluSetId or contextInfo; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure; UnsupportedActionException - CLU set is dynamically determined

getLuDao

public LuDao getLuDao()

setLuDao

public void setLuDao(LuDao luDao)

addCluSetsToCluSet

@Transactional(readOnly=false)
public StatusInfo addCluSetsToCluSet(String cluSetId,
                                                           List<String> cluSetIds,
                                                           ContextInfo context)
                              throws CircularRelationshipException,
                                     DoesNotExistException,
                                     InvalidParameterException,
                                     MissingParameterException,
                                     OperationFailedException,
                                     PermissionDeniedException,
                                     UnsupportedActionException

Description copied from interface: CluService

Adds a list of CLU sets to another CluSet. If any individual one would fail, then an error is returned and none are added.

Specified by:: addCluSetsToCluSet in interface CluService

Parameters:: cluSetId - identifier of the host CLU set; cluSetIds - list of identifiers of the CLU sets to be added; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: status of the operation (success or failure)
Throws:: CircularRelationshipException - addedCluSetIds cannot be added to the cluSetId; DoesNotExistException - cluSetId, one or more of cluSetIds in addedCluSetIds not found; InvalidParameterException - invalid contextInfo; MissingParameterException - missing cluSetId, addedCluSetIds or contextInfo; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure; UnsupportedActionException - CLU set is dynamically determined

addClusToCluSet

@Transactional(readOnly=false)
public StatusInfo addClusToCluSet(List<String> cluIds,
                                                        String cluSetId,
                                                        ContextInfo context)
                           throws DoesNotExistException,
                                  InvalidParameterException,
                                  MissingParameterException,
                                  OperationFailedException,
                                  PermissionDeniedException,
                                  UnsupportedActionException

Description copied from interface: CluService

Adds a list of CLUs to a CLU set. If any individual one would fail, then an error is returned and none are added.

Specified by:: addClusToCluSet in interface CluService

Parameters:: cluIds - list of identifiers of CLUs to add to the CLU set; cluSetId - identifier of the CLU set to be added; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: status of the operation (success or failure)
Throws:: DoesNotExistException - cluSetIds, cluSetId not found; InvalidParameterException - invalid contextInfo; MissingParameterException - missing cluSetIds, cluSetId or contextInfo; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure; UnsupportedActionException - CLU set is dynamically determined

getValidatorFactory

public ValidatorFactory getValidatorFactory()

setValidatorFactory

public void setValidatorFactory(ValidatorFactory validatorFactory)

createNewCluVersion

@Transactional(readOnly=false)
public CluInfo createNewCluVersion(String versionIndCluId,
                                                         String versionComment,
                                                         ContextInfo context)
                            throws DataValidationErrorException,
                                   DoesNotExistException,
                                   InvalidParameterException,
                                   MissingParameterException,
                                   OperationFailedException,
                                   PermissionDeniedException

Versioning Methods

Specified by:: createNewCluVersion in interface CluService

Parameters:: versionIndCluId - identifier for the CLU to be versioned; versionComment - comment for the current version; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: the new versioned CLU information
Throws:: DataValidationErrorException - supplied data is invalid; DoesNotExistException - cluId not found; InvalidParameterException - invalid contextInfo; MissingParameterException - missing cluId, versionComment or contextInfo; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

setCurrentCluVersion

@Transactional(readOnly=false)
public StatusInfo setCurrentCluVersion(String cluVersionId,
                                                             Date currentVersionStart,
                                                             ContextInfo context)
                                throws DoesNotExistException,
                                       InvalidParameterException,
                                       MissingParameterException,
                                       IllegalVersionSequencingException,
                                       OperationFailedException,
                                       PermissionDeniedException

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. This will NOT update state of the current or previously current CLU. All state changes must be handled either by the business service or from the atpService application.

Specified by:: setCurrentCluVersion in interface CluService

Parameters:: 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 Clu; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: status of the operation
Throws:: DoesNotExistException - cluVersionId not found; InvalidParameterException - invalid contextInfo; MissingParameterException - missing cluVersionId, previousState, newState; IllegalVersionSequencingException - a Clu with higher sequence number from the one provided is marked current; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

search

@Transactional(readOnly=true)
public SearchResult search(SearchRequest searchRequest)
                    throws MissingParameterException

Specified by:: search in interface SearchService
Specified by:: search in interface CluService

Throws:: MissingParameterException

getLatestVersion

public VersionDisplayInfo getLatestVersion(String refObjectTypeURI,
                                           String refObjectId,
                                           ContextInfo context)
                                    throws DoesNotExistException,
                                           InvalidParameterException,
                                           MissingParameterException,
                                           OperationFailedException,
                                           PermissionDeniedException

Description copied from interface: VersionManagementService

Retrieves latest version associated with the objectId. This is not always the current version. A current version is what is being used by the system right now, but there could be draft version created after the current version.

Specified by:: getLatestVersion in interface VersionManagementService

Parameters:: refObjectTypeURI - reference object type URI; refObjectId - reference object Id; context - context information containing the principalId and locale information about the caller of service operation
Returns:: latest version
Throws:: DoesNotExistException - specified refObjectId and refObjectUri not found; InvalidParameterException - contextInfo is not valid; MissingParameterException - refObjectUri, refObjectId or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

getCurrentVersion

public VersionDisplayInfo getCurrentVersion(String refObjectTypeURI,
                                            String refObjectId,
                                            ContextInfo context)
                                     throws DoesNotExistException,
                                            InvalidParameterException,
                                            MissingParameterException,
                                            OperationFailedException,
                                            PermissionDeniedException

Description copied from interface: VersionManagementService

Retrieves current version associated with the objectId.

Specified by:: getCurrentVersion in interface VersionManagementService

Parameters:: refObjectTypeURI - reference object type URI; refObjectId - reference object Id; context - context information containing the principalId and locale information about the caller of service operation
Returns:: current version
Throws:: DoesNotExistException - specified refObjectUri and refObjectId not found; InvalidParameterException - contextInfo is not valid; MissingParameterException - refObjectUri, refObjectId or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

getCurrentVersionOnDate

public VersionDisplayInfo getCurrentVersionOnDate(String refObjectTypeURI,
                                                  String refObjectId,
                                                  Date date,
                                                  ContextInfo context)
                                           throws DoesNotExistException,
                                                  InvalidParameterException,
                                                  MissingParameterException,
                                                  OperationFailedException,
                                                  PermissionDeniedException

Description copied from interface: VersionManagementService

Retrieves the current version associated with the objectId on a given date.

Specified by:: getCurrentVersionOnDate in interface VersionManagementService

Parameters:: refObjectTypeURI - reference object type URI; refObjectId - reference object Id; date - date; context - context information containing the principalId and locale information about the caller of service operation
Returns:: current version on given date
Throws:: DoesNotExistException - specified refObjectId and refObjectUri not found; InvalidParameterException - date or contextInfo is not valid; MissingParameterException - refObjectUri, refObjectId, date or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

getFirstVersion

public VersionDisplayInfo getFirstVersion(String refObjectTypeURI,
                                          String refObjectId,
                                          ContextInfo context)
                                   throws DoesNotExistException,
                                          InvalidParameterException,
                                          MissingParameterException,
                                          OperationFailedException,
                                          PermissionDeniedException

Description copied from interface: VersionManagementService

Retrieves first version associated with the objectId.

Specified by:: getFirstVersion in interface VersionManagementService

Parameters:: refObjectTypeURI - reference object type URI; refObjectId - reference object Id; context - context information containing the principalId and locale information about the caller of service operation
Returns:: first version
Throws:: DoesNotExistException - refObjectUri or refObjectId not found; InvalidParameterException - contextInfo is not valid; MissingParameterException - refObjectUri, refObjectId or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

getVersionBySequenceNumber

public VersionDisplayInfo getVersionBySequenceNumber(String refObjectTypeURI,
                                                     String refObjectId,
                                                     Long sequence,
                                                     ContextInfo context)
                                              throws DoesNotExistException,
                                                     InvalidParameterException,
                                                     MissingParameterException,
                                                     OperationFailedException,
                                                     PermissionDeniedException

Description copied from interface: VersionManagementService

Retrieves the version associated with the objectId and the sequence number.

Specified by:: getVersionBySequenceNumber in interface VersionManagementService

Parameters:: refObjectTypeURI - reference object type URI; refObjectId - reference object Id; sequence - sequence number; context - context information containing the principalId and locale information about the caller of service operation
Returns:: version matching the sequence
Throws:: DoesNotExistException - specified refObjectUri, refObjectId or sequence not found; InvalidParameterException - sequence or contextInfo is not valid; MissingParameterException - refObjectUri, refObjectId, sequence or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

getVersions

public List<VersionDisplayInfo> getVersions(String refObjectTypeURI,
                                            String refObjectId,
                                            ContextInfo context)
                                     throws DoesNotExistException,
                                            InvalidParameterException,
                                            MissingParameterException,
                                            OperationFailedException,
                                            PermissionDeniedException

Description copied from interface: VersionManagementService

Retrieves a list of versions associated with the objectId.

Specified by:: getVersions in interface VersionManagementService

Parameters:: refObjectTypeURI - reference object type URI; refObjectId - reference object Id; context - context information containing the principalId and locale information about the caller of service operation
Returns:: a list of versions
Throws:: DoesNotExistException - refObjectUri or refObjectId not found; InvalidParameterException - invalid contextInfo; MissingParameterException - refObjectUri, refObjectId or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

getVersionsInDateRange

public List<VersionDisplayInfo> getVersionsInDateRange(String refObjectTypeURI,
                                                       String refObjectId,
                                                       Date from,
                                                       Date to,
                                                       ContextInfo context)
                                                throws DoesNotExistException,
                                                       InvalidParameterException,
                                                       MissingParameterException,
                                                       OperationFailedException,
                                                       PermissionDeniedException

Description copied from interface: VersionManagementService

Retrieves the current version associated with the objectId in a given date range

Specified by:: getVersionsInDateRange in interface VersionManagementService

Parameters:: refObjectTypeURI - reference object type URI; refObjectId - reference object Id; from - from date; to - to date; context - context information containing the principalId and locale information about the caller of service operation
Returns:: current version in given date range
Throws:: DoesNotExistException - specified refObjectId and refObjectUri not found; InvalidParameterException - from, to or contextInfo is not valid; MissingParameterException - refObjectUri, refObjectId, from, to or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

setSearchDispatcher

public void setSearchDispatcher(SearchDispatcher searchDispatcher)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.kuali.student.r2.lum.lu.service.impl Class CluServiceImpl

CluServiceImpl

setDictionaryServiceDelegate

getDictionaryServiceDelegate

getSearchCriteriaType

getSearchCriteriaTypes

getSearchResultType

getSearchResultTypes

getSearchType

getSearchTypes

getSearchTypesByCriteria

getSearchTypesByResult

getSearchManager

setSearchManager

getDeliveryMethodTypes

getDeliveryMethodType

getInstructionalFormatTypes

getInstructionalFormatType

getLuTypes

getLuType

getLuCodeType

getLuCodeTypes

getCluCluRelationTypes

getLuLuRelationType

getAllowedLuLuRelationTypesForLuType

getLuPublicationTypes

getLuPublicationType

getLuPublicationTypesForLuType

getCluResultTypes

getCluResultType

getCluResultTypesForLuType

getResultUsageTypes

getResultUsageType

getAllowedResultUsageTypesForLuType

getAllowedResultComponentTypesForResultUsageType

getCluLoRelationType

getCluLoRelationTypes

getAllowedCluLoRelationTypesForLuType

getCluSetTypes

getCluSetType

getClu

getClusByIds

getClusByLuType

getCluIdsByLuType

getAllowedCluCluRelationTypesByClu

getClusByRelatedCluAndRelationType

getCluIdsByRelatedCluAndRelationType

getRelatedClusByCluAndRelationType

getRelatedCluIdsByCluAndRelationType

getCluCluRelation

getCluCluRelationsByClu

getCluPublicationsByClu

getCluPublicationsByType

getCluPublication

getCluResult

getCluResultByClu

getCluIdsByResultUsageType

getCluIdsByResultComponent

getCluLoRelation

getCluLoRelationsByClu

getCluLoRelationsByLo

getResourceRequirementsForClu

getCluSet

getCluSetTreeView

getCluSetsByIds

getCluSetIdsFromCluSet

isCluSetDynamic

getClusFromCluSet

getCluIdsFromCluSet

getAllClusInCluSet

getAllCluIdsInCluSet

isCluInCluSet

validateClu

createClu

toCluForCreate

updateClu

deleteClu

updateCluState

validateCluCluRelation

createCluCluRelation

org.kuali.student.r2.lum.lu.service.impl
Class CluServiceImpl