LuServiceImpl (Kuali Student 1.2-M4-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.lum.lu.service.impl
Class LuServiceImpl

java.lang.Object
  org.kuali.student.lum.lu.service.impl.LuServiceImpl

All Implemented Interfaces:: DictionaryService, SearchService, VersionManagementService, LuService

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

Nested Class Summary
`class`	`LuServiceImpl.SearchResultRowComparator`

Field Summary
`private DictionaryService`	`dictionaryServiceDelegate`
`(package private) Logger`	`logger`
`private LuDao`	`luDao`
`private static String`	`SEARCH_KEY_BROWSE_PROGRAM`
`private static String`	`SEARCH_KEY_BROWSE_VARIATIONS`
`private static String`	`SEARCH_KEY_BROWSE_VERSIONS`
`private static String`	`SEARCH_KEY_DEPENDENCY_ANALYSIS`
`private static String`	`SEARCH_KEY_PROPOSALS_BY_COURSE_CODE`
`private static String`	`SEARCH_KEY_RESULT_COMPONENT`
`private SearchDispatcher`	`searchDispatcher`
`private SearchManager`	`searchManager`
`private ValidatorFactory`	`validatorFactory`

Constructor Summary
`LuServiceImpl()`

Method Summary
`StatusInfo`	`addCluResourceRequirement(String resourceTypeKey, String cluId)` Add a Resource requirement to a CLU
`StatusInfo`	`addCluSetsToCluSet(String cluSetId, List<String> cluSetIdList)` Adds a list of CLU sets to another CluSet.
`StatusInfo`	`addCluSetToCluSet(String cluSetId, String addedCluSetId)` Adds one CLU set to another
`StatusInfo`	`addClusToCluSet(List<String> cluIdList, String cluSetId)` Adds a list of CLUs to a CLU set.
`StatusInfo`	`addCluToCluSet(String cluId, String cluSetId)` Add a CLU to a CLU set
`private void`	`checkCluAlreadyAdded(CluSet cluSet, String cluId)`
`private void`	`checkCluSetAlreadyAdded(CluSet cluSet, String cluSetIdToAdd)`
`private void`	`checkCluSetCircularReference(CluSet addedCluSet, String hostCluSetId)`
`private void`	`checkForEmptyList(Object param, String paramName)`
`private void`	`checkForMissingParameter(Object param, String paramName)` Check for missing parameter and throw localized exception if missing
`private void`	`clearCluIds(CluInfo clu)`
`CluInfo`	`createClu(String luTypeKey, CluInfo cluInfo)` Creates a new CLU
`CluCluRelationInfo`	`createCluCluRelation(String cluId, String relatedCluId, String luLuRelationTypeKey, CluCluRelationInfo cluCluRelationInfo)` Create a directional relationship between two CLUs
`CluLoRelationInfo`	`createCluLoRelation(String cluId, String loId, String cluLoRelationType, CluLoRelationInfo cluLoRelationInfo)` Creates a relationship between a learning objective and a CLU.
`CluPublicationInfo`	`createCluPublication(String cluId, String luPublicationType, CluPublicationInfo cluPublicationInfo)` Create a clu publication object, which contains information about publication for a clu.
`CluResultInfo`	`createCluResult(String cluId, String cluResultTypeKey, CluResultInfo cluResultInfo)` Create a clu result object, which contains information about potential results for a clu.
`CluSetInfo`	`createCluSet(String cluSetType, CluSetInfo cluSetInfo)` Creates a CLU set.
`LuiInfo`	`createLui(String cluId, String atpKey, LuiInfo luiInfo)` Creates a new LUI
`LuiLuiRelationInfo`	`createLuiLuiRelation(String luiId, String relatedLuiId, String luLuRelationTypeKey, LuiLuiRelationInfo luiLuiRelationInfo)` Create a relationship between two LUIs
`CluInfo`	`createNewCluVersion(String versionIndCluId, String versionComment)` Versioning Methods
`StatusInfo`	`deleteClu(String cluId)` Deletes an existing CLU
`StatusInfo`	`deleteCluCluRelation(String cluCluRelationId)` Deletes a relationship between two CLUs
`StatusInfo`	`deleteCluLoRelation(String cluLoRelationId)` Removes a relationship between a learning objective and a Clu.
`StatusInfo`	`deleteCluPublication(String cluPublicationId)` Deletes an existing clu publication object
`StatusInfo`	`deleteCluResult(String cluResultId)` Deletes an existing clu result
`StatusInfo`	`deleteCluSet(String cluSetId)` Delete a CLU set
`StatusInfo`	`deleteLui(String luiId)` Deletes a LUI record
`StatusInfo`	`deleteLuiLuiRelation(String luiLuiRelationId)` Deletes a relationship between two LUIs
`private SearchResult`	`doBrowseProgramSearch()`
`private SearchResult`	`doBrowseVersionsSearch(SearchRequest searchRequest)` Looks up Atp descriptions and adds to search results
`private SearchResult`	`doDependencyAnalysisSearch(String cluId)`
`private void`	`doFindClusInCluSet(List<String> processedCluSetIds, List<String> clus, CluSet parentCluSet)`
`private SearchResult`	`doSearchProposalsByCourseCode(String courseCode)`
`private void`	`findClusInCluSet(List<String> clus, CluSet parentCluSet)`
`List<String>`	`getAllCluIdsInCluSet(String cluSetId)` Retrieves the list of CLU Identifiers within a CLU Set or any cluset that is included within that.
`List<CluInfo>`	`getAllClusInCluSet(String cluSetId)` Retrieves the full list of CLUs in this CLU set or any cluset that is included within that.
`List<String>`	`getAllowedCluLoRelationTypesForLuType(String luTypeKey)` Retrieves the list of CLU LO relation types which are allowed to be used in conjunction with an lu type.
`List<String>`	`getAllowedLuLuRelationTypesByCluId(String cluId, String relatedCluId)` Retrieves the list of allowed relation types between the two specified CLUs
`List<String>`	`getAllowedLuLuRelationTypesByLuiId(String luiId, String relatedLuiId)` Retrieves the list of allowed relation types between the two specified LUIs
`List<String>`	`getAllowedLuLuRelationTypesForLuType(String luTypeKey, String relatedLuTypeKey)` Retrieves the list of allowed relation types between the two specified LU Types
`List<String>`	`getAllowedResultComponentTypesForResultUsageType(String resultUsageTypeKey)` Retrieves the list of result component types which are allowed to be used in conjunction with result usage type.
`List<String>`	`getAllowedResultUsageTypesForLuType(String luTypeKey)` Retrieves the list of result usage types which are allowed to be used in conjunction with an lu type.
`CluInfo`	`getClu(String cluId)` READ OPERATION *
`CluCluRelationInfo`	`getCluCluRelation(String cluCluRelationId)` Retrieves the relationship information between CLUs for a particular Relation instance
`List<CluCluRelationInfo>`	`getCluCluRelationsByClu(String cluId)` Retrieves the list of relationship information for the specified CLU
`List<String>`	`getCluIdsByLuType(String luTypeKey, String luState)` Retrieves the list of CLU ids for the specified LU Type and state
`List<String>`	`getCluIdsByRelation(String relatedCluId, String luLuRelationTypeKey)` Retrieves the list of CLU Ids for the specified related CLU Id and LU to LU relation type (getRelatedCluIdsByCluId from the other direction)
`List<String>`	`getCluIdsByResultComponent(String resultComponentId)` Retrieves the list of clu ids which use a particular result component
`List<String>`	`getCluIdsByResultUsageType(String resultUsageTypeKey)` Retrieves the list of clu ids with the results of the specified usage type.
`List<String>`	`getCluIdsFromCluSet(String cluSetId)` Retrieves the list of CLU Identifiers within a CLU Set.
`CluLoRelationInfo`	`getCluLoRelation(String cluLoRelationId)` Retrieve information on a CLU LO Relation.
`List<CluLoRelationInfo>`	`getCluLoRelationsByClu(String cluId)` Retrieves the list of canonical learning unit to learning objective relationships for a given CLU.
`List<CluLoRelationInfo>`	`getCluLoRelationsByLo(String loId)` Retrieves the list of CLU identifiers associated with a given learning objective identifier.
`CluLoRelationTypeInfo`	`getCluLoRelationType(String cluLoRelationTypeKey)` Retrieves information for a specified CLU to LO relation type
`List<CluLoRelationTypeInfo>`	`getCluLoRelationTypes()` Retrieves the complete list of CLU to LO relation types
`CluPublicationInfo`	`getCluPublication(String cluPublicationId)` Retrieves an LU publication object by its identifier
`List<CluPublicationInfo>`	`getCluPublicationsByCluId(String cluId)` Retrieves a list of publication objects for a particular clu
`List<CluPublicationInfo>`	`getCluPublicationsByType(String luPublicationTypeKey)` Retrieves a list of publication objects of a particular Type
`CluResultInfo`	`getCluResult(String cluResultId)` Retrieves information about a Clu Result
`List<CluResultInfo>`	`getCluResultByClu(String cluId)` Retrieves the cluResult for a particular clu
`CluResultTypeInfo`	`getCluResultType(String cluResultTypeKey)` Retrieves information about a publication type
`List<CluResultTypeInfo>`	`getCluResultTypes()` Retrieves a list of types for clu result objects.
`List<CluResultTypeInfo>`	`getCluResultTypesForLuType(String luTypeKey)` Retrieves the list of clu result types which are allowed to be used in conjunction with a particular lu type.
`List<CluInfo>`	`getClusByIdList(List<String> cluIdList)` Retrieves information about CLUs from a list of ids
`List<CluInfo>`	`getClusByLuType(String luTypeKey, String luState)` Retrieves the list of CLUs for the specified LU Type and state
`List<CluInfo>`	`getClusByRelation(String relatedCluId, String luLuRelationTypeKey)` Retrieves the list of CLU information for the CLUs related to a specified CLU Id with a certain LU to LU relation type (getRelatedClusByCluId from the other direction)
`List<String>`	`getCluSetIdsFromCluSet(String cluSetId)` Retrieve the list of CLU Set Ids within a CLU Set
`CluSetInfo`	`getCluSetInfo(String cluSetId)` Retrieve information on a CLU set.
`List<CluSetInfo>`	`getCluSetInfoByIdList(List<String> cluSetIdList)` Retrieve information on CLU sets from a list of cluSet Ids.
`CluSetTreeViewInfo`	`getCluSetTreeView(String cluSetId)` Retrieve information on a CLU set and its sub clu set fully expanded.
`private void`	`getCluSetTreeViewHelper(CluSetInfo cluSetInfo, CluSetTreeViewInfo cluSetTreeViewInfo)` Go through the list of CluSets and retrieve all the information regarding child Clu Sets and associated Clus
`CluSetTypeInfo`	`getCluSetType(String cluSetTypeKey)` Retrieves information about a specified CLU set type
`List<CluSetTypeInfo>`	`getCluSetTypes()` Retrieves the list of CLU set types known by the service
`List<CluInfo>`	`getClusFromCluSet(String cluSetId)` Retrieves the list of CLUs in a CLU set.
`VersionDisplayInfo`	`getCurrentVersion(String refObjectTypeURI, String refObjectId)` Retrieves current version associated with the objectId.
`VersionDisplayInfo`	`getCurrentVersionOnDate(String refObjectTypeURI, String refObjectId, Date date)` Retrieves the current version associated with the objectId on a given date.
`DeliveryMethodTypeInfo`	`getDeliveryMethodType(String deliveryMethodTypeKey)` Retrieves information about a delivery method type
`List<DeliveryMethodTypeInfo>`	`getDeliveryMethodTypes()` SETUP OPERATION *
`DictionaryService`	`getDictionaryServiceDelegate()`
`VersionDisplayInfo`	`getFirstVersion(String refObjectTypeURI, String refObjectId)` Retrieves first version associated with the objectId.
`InstructionalFormatTypeInfo`	`getInstructionalFormatType(String instructionalFormatTypeKey)` Retrieves information about a Instructional Format Type
`List<InstructionalFormatTypeInfo>`	`getInstructionalFormatTypes()` Retrieves the list of instructional format types
`VersionDisplayInfo`	`getLatestVersion(String refObjectTypeURI, String refObjectId)` Retrieves latest version associated with the objectId.
`LuCodeTypeInfo`	`getLuCodeType(String luCodeTypeKey)` Retrieves information about a learning unit code type
`List<LuCodeTypeInfo>`	`getLuCodeTypes()` Retrieves the list of learning unit code types
`LuDao`	`getLuDao()`
`LuiInfo`	`getLui(String luiId)` Retrieves information about a LUI
`List<String>`	`getLuiIdsByCluId(String cluId)` Retrieves the list of LUI ids for the specified CLU
`List<String>`	`getLuiIdsByRelation(String luiId, String luLuRelationTypeKey)` Retrieves the list of LUI Ids for the specified related LUI Id and LU to LU relation type (getRelatedLuiIdsByLuiId from the other direction)
`List<String>`	`getLuiIdsInAtpByCluId(String cluId, String atpKey)` Retrieves the list of LUI ids for the specified CLU and Time period
`LuiLuiRelationInfo`	`getLuiLuiRelation(String luiLuiRelationId)` Retrieves the relationship information between LUIs given a specific relation instance
`List<LuiLuiRelationInfo>`	`getLuiLuiRelationsByLui(String luiId)` Retrieves the list of relationship information for the specified LUI
`List<LuiInfo>`	`getLuisByIdList(List<String> luiIdList)` Retrieves information about LUIs from a list of Ids
`List<LuiInfo>`	`getLuisByRelation(String luiId, String luLuRelationTypeKey)` Retrieves the list of LUI information for the LUIs related to the specified LUI Id with a certain LU to LU relation type (getRelatedLuisByLuiId from the other direction)
`List<LuiInfo>`	`getLuisInAtpByCluId(String cluId, String atpKey)` Retrieves the list of LUIs for the specified CLU and period
`LuLuRelationTypeInfo`	`getLuLuRelationType(String luLuRelationTypeKey)` Retrieves the LU to LU relation type
`List<LuLuRelationTypeInfo>`	`getLuLuRelationTypes()` Retrieves the complete list of LU to LU relation types
`LuPublicationTypeInfo`	`getLuPublicationType(String luPublicationTypeKey)` Retrieves information about a publication type
`List<LuPublicationTypeInfo>`	`getLuPublicationTypes()` Retrieves the list of Learning Unit publication types
`List<String>`	`getLuPublicationTypesForLuType(String luTypeKey)` Retrieves information about a publication type
`LuTypeInfo`	`getLuType(String luTypeKey)` Retrieves information about a LU Type
`List<LuTypeInfo>`	`getLuTypes()` Retrieves the list of LU types
`private List<String>`	`getMembershipQuerySearchResult(MembershipQueryInfo query)`
`ObjectStructureDefinition`	`getObjectStructure(String objectTypeKey)`
`List<String>`	`getObjectTypes()`
`List<String>`	`getRelatedCluIdsByCluId(String cluId, String luLuRelationTypeKey)` Retrieves the list of related CLU Ids for the specified CLU Id and LU to LU relation type (getCluIdsByRelation from the other direction)
`List<CluInfo>`	`getRelatedClusByCluId(String cluId, String luLuRelationTypeKey)` 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>`	`getRelatedLuiIdsByLuiId(String luiId, String luLuRelationTypeKey)` Retrieves the list of related LUI Ids for the specified LUI Id and LU to LU relation type.
`List<LuiInfo>`	`getRelatedLuisByLuiId(String luiId, String luLuRelationTypeKey)` Retrieves the list of related LUI information for the specified LUI Id and LU to LU relation type (getLuisByRelation from the other direction)
`List<String>`	`getResourceRequirementsForCluId(String cluId)` Retrieves the list of Resource requirements for the specified CLU
`ResultUsageTypeInfo`	`getResultUsageType(String resultUsageTypeKey)` Retrieves information about a Result Usage Type
`List<ResultUsageTypeInfo>`	`getResultUsageTypes()` Retrieves a list of result usage types
`SearchCriteriaTypeInfo`	`getSearchCriteriaType(String searchCriteriaTypeKey)` SEARCH OPERATIONS *
`List<SearchCriteriaTypeInfo>`	`getSearchCriteriaTypes()` Retrieves the list of search criteria types known by this service.
`SearchResultTypeInfo`	`getSearchResultType(String searchResultTypeKey)` Retrieves information about a particular search result type.
`List<SearchResultTypeInfo>`	`getSearchResultTypes()` Retrieves the list of search result types known by this service.
`SearchTypeInfo`	`getSearchType(String searchTypeKey)` Retrieves information about a particular search type.
`List<SearchTypeInfo>`	`getSearchTypes()` Retrieves the list of search types known by this service.
`List<SearchTypeInfo>`	`getSearchTypesByCriteria(String searchCriteriaTypeKey)` Retrieves the list of search types which use criteria in the specified format.
`List<SearchTypeInfo>`	`getSearchTypesByResult(String searchResultTypeKey)` Retrieves the list of search types which return results in the specified format.
`ValidatorFactory`	`getValidatorFactory()`
`VersionDisplayInfo`	`getVersionBySequenceNumber(String refObjectTypeURI, String refObjectId, Long sequence)` Retrieves the version associated with the objectId and the sequence number.
`List<VersionDisplayInfo>`	`getVersions(String refObjectTypeURI, String refObjectId)` Retrieves list of version associated with the objectId.
`List<VersionDisplayInfo>`	`getVersionsInDateRange(String refObjectTypeURI, String refObjectId, Date from, Date to)` Retrieves the current version associated with the objectId on a given date.
`Boolean`	`isCluInCluSet(String cluId, String cluSetId)` Checks if a CLU is a member of a CLU set or any contained CLU set
`Boolean`	`isCluSetDynamic(String cluSetId)` Check if the given CluSet is dynamic
`StatusInfo`	`removeCluFromCluSet(String cluId, String cluSetId)` Remove a CLU from a CLU set
`StatusInfo`	`removeCluResourceRequirement(String resourceTypeKey, String cluId)` Remove a Resource requirement from a CLU
`StatusInfo`	`removeCluSetFromCluSet(String cluSetId, String removedCluSetId)` Removes one CLU set from another
`SearchResult`	`search(SearchRequest searchRequest)`
`StatusInfo`	`setCurrentCluVersion(String cluVersionId, Date currentVersionStart)` 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)`
`private void`	`setMembershipQuerySearchResult(CluSetInfo cluSetInfo)`
`void`	`setSearchDispatcher(SearchDispatcher searchDispatcher)`
`void`	`setSearchManager(SearchManager searchManager)`
`void`	`setValidatorFactory(ValidatorFactory validatorFactory)`
`Clu`	`toCluForCreate(String luTypeKey, CluInfo cluInfo)`
`CluInfo`	`updateClu(String cluId, CluInfo cluInfo)` Updates an existing CLU
`CluCluRelationInfo`	`updateCluCluRelation(String cluCluRelationId, CluCluRelationInfo cluCluRelationInfo)` Updates a relationship between two CLUs
`CluLoRelationInfo`	`updateCluLoRelation(String cluLoRelationId, CluLoRelationInfo cluLoRelationInfo)` Updates a relationship between a clu and learning objective
`CluPublicationInfo`	`updateCluPublication(String cluPublicationId, CluPublicationInfo cluPublicationInfo)` Updates an existing clu publication object
`CluResultInfo`	`updateCluResult(String cluResultId, CluResultInfo cluResultInfo)` Updates an existing clu result
`CluSetInfo`	`updateCluSet(String cluSetId, CluSetInfo cluSetInfo)` Update the information for a CLU set
`CluInfo`	`updateCluState(String cluId, String luState)` Updates the state of the specified CLU
`LuiInfo`	`updateLui(String luiId, LuiInfo luiInfo)` Updates an existing LUI
`LuiLuiRelationInfo`	`updateLuiLuiRelation(String luiLuiRelationId, LuiLuiRelationInfo luiLuiRelationInfo)` Updates a relationship between two LUIs
`LuiInfo`	`updateLuiState(String luiId, String luiState)` Updates the state of the LUI
`List<ValidationResultInfo>`	`validateClu(String validationType, CluInfo cluInfo)` MAINTENANCE OPERATIONS *
`List<ValidationResultInfo>`	`validateCluCluRelation(String validationType, CluCluRelationInfo cluCluRelationInfo)` Validates a cluCluRelation.
`List<ValidationResultInfo>`	`validateCluLoRelation(String validationType, CluLoRelationInfo cluLoRelationInfo)` Validates a cluLoRelation.
`List<ValidationResultInfo>`	`validateCluPublication(String validationType, CluPublicationInfo cluPublicationInfo)` Validates information about publication for a clu.
`List<ValidationResultInfo>`	`validateCluResult(String validationType, CluResultInfo cluResultInfo)` Validates information about results for a clu.
`private void`	`validateCluSet(CluSetInfo cluSetInfo)`
`List<ValidationResultInfo>`	`validateCluSet(String validationType, CluSetInfo cluSetInfo)` Validates information about a clu set.
`List<ValidationResultInfo>`	`validateLui(String validationType, LuiInfo luiInfo)` Validates a LUI.
`List<ValidationResultInfo>`	`validateLuiLuiRelation(String validationType, LuiLuiRelationInfo luiLuiRelationInfo)` Validates a relationship between LUIs.

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

Field Detail

SEARCH_KEY_DEPENDENCY_ANALYSIS

private static final String SEARCH_KEY_DEPENDENCY_ANALYSIS

See Also:: Constant Field Values

SEARCH_KEY_BROWSE_PROGRAM

private static final String SEARCH_KEY_BROWSE_PROGRAM

See Also:: Constant Field Values

SEARCH_KEY_BROWSE_VARIATIONS

private static final String SEARCH_KEY_BROWSE_VARIATIONS

See Also:: Constant Field Values

SEARCH_KEY_RESULT_COMPONENT

private static final String SEARCH_KEY_RESULT_COMPONENT

See Also:: Constant Field Values

SEARCH_KEY_PROPOSALS_BY_COURSE_CODE

private static final String SEARCH_KEY_PROPOSALS_BY_COURSE_CODE

See Also:: Constant Field Values

SEARCH_KEY_BROWSE_VERSIONS

private static final String SEARCH_KEY_BROWSE_VERSIONS

See Also:: Constant Field Values

logger

final Logger logger

luDao

private LuDao luDao

searchManager

private SearchManager searchManager

searchDispatcher

private SearchDispatcher searchDispatcher

dictionaryServiceDelegate

private DictionaryService dictionaryServiceDelegate

validatorFactory

private ValidatorFactory validatorFactory

Constructor Detail

LuServiceImpl

public LuServiceImpl()

Method Detail

setSearchManager

public void setSearchManager(SearchManager searchManager)

setDictionaryServiceDelegate

public void setDictionaryServiceDelegate(DictionaryService dictionaryServiceDelegate)

getDictionaryServiceDelegate

public DictionaryService getDictionaryServiceDelegate()

getDeliveryMethodTypes

public List<DeliveryMethodTypeInfo> getDeliveryMethodTypes()
                                                    throws OperationFailedException

SETUP OPERATION *

Specified by:: getDeliveryMethodTypes in interface LuService

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

getDeliveryMethodType

public DeliveryMethodTypeInfo getDeliveryMethodType(String deliveryMethodTypeKey)
                                             throws DoesNotExistException,
                                                    InvalidParameterException,
                                                    MissingParameterException,
                                                    OperationFailedException

Description copied from interface: LuService

Retrieves information about a delivery method type

Specified by:: getDeliveryMethodType in interface LuService

Parameters:: deliveryMethodTypeKey - Key of the Delivery Method Type
Returns:: information about a Delivery Method Type
Throws:: DoesNotExistException - deliveryMethodType not found; InvalidParameterException - invalid deliveryMethodType; MissingParameterException - missing deliveryMethodType; OperationFailedException - unable to complete request

getInstructionalFormatTypes

public List<InstructionalFormatTypeInfo> getInstructionalFormatTypes()
                                                              throws OperationFailedException

Description copied from interface: LuService

Retrieves the list of instructional format types

Specified by:: getInstructionalFormatTypes in interface LuService

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

getInstructionalFormatType

public InstructionalFormatTypeInfo getInstructionalFormatType(String instructionalFormatTypeKey)
                                                       throws DoesNotExistException,
                                                              InvalidParameterException,
                                                              MissingParameterException,
                                                              OperationFailedException

Description copied from interface: LuService

Retrieves information about a Instructional Format Type

Specified by:: getInstructionalFormatType in interface LuService

Parameters:: instructionalFormatTypeKey - Key of the Instructional Format Type
Returns:: information about a Instructional Format Type
Throws:: DoesNotExistException - instructionalFormatType not found; InvalidParameterException - invalid instructionalFormatType; MissingParameterException - missing instructionalFormatType; OperationFailedException - unable to complete request

getLuTypes

public List<LuTypeInfo> getLuTypes()
                            throws OperationFailedException

Description copied from interface: LuService

Retrieves the list of LU types

Specified by:: getLuTypes in interface LuService

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

getLuType

public LuTypeInfo getLuType(String luTypeKey)
                     throws DoesNotExistException,
                            InvalidParameterException,
                            MissingParameterException,
                            OperationFailedException

Description copied from interface: LuService

Retrieves information about a LU Type

Specified by:: getLuType in interface LuService

Parameters:: luTypeKey - Key of the LU Type
Returns:: information about a LU Type
Throws:: DoesNotExistException - luType not found; InvalidParameterException - invalid luType; MissingParameterException - missing luType; OperationFailedException - unable to complete request

getLuCodeType

public LuCodeTypeInfo getLuCodeType(String luCodeTypeKey)
                             throws DoesNotExistException,
                                    InvalidParameterException,
                                    MissingParameterException,
                                    OperationFailedException

Description copied from interface: LuService

Retrieves information about a learning unit code type

Specified by:: getLuCodeType in interface LuService

Parameters:: luCodeTypeKey - Key of the learning unit code type
Returns:: information about a learning unit code type
Throws:: DoesNotExistException - luCodeTypeKey not found; InvalidParameterException - invalid luCodeTypeKey; MissingParameterException - missing luCodeTypeKey; OperationFailedException - unable to complete request

getLuCodeTypes

public List<LuCodeTypeInfo> getLuCodeTypes()
                                    throws OperationFailedException

Description copied from interface: LuService

Retrieves the list of learning unit code types

Specified by:: getLuCodeTypes in interface LuService

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

getLuLuRelationTypes

public List<LuLuRelationTypeInfo> getLuLuRelationTypes()
                                                throws OperationFailedException

Description copied from interface: LuService

Retrieves the complete list of LU to LU relation types

Specified by:: getLuLuRelationTypes in interface LuService

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

getLuLuRelationType

public LuLuRelationTypeInfo getLuLuRelationType(String luLuRelationTypeKey)
                                         throws OperationFailedException,
                                                MissingParameterException,
                                                DoesNotExistException

Description copied from interface: LuService

Retrieves the LU to LU relation type

Specified by:: getLuLuRelationType in interface LuService

Parameters:: luLuRelationTypeKey - Key of the LU to LU Relation Type
Returns:: LU to LU relation type information
Throws:: OperationFailedException - unable to complete request; MissingParameterException - missing luLuRelationTypeKey; DoesNotExistException - luLuRelationTypeKey not found

getAllowedLuLuRelationTypesForLuType

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

Description copied from interface: LuService

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

Specified by:: getAllowedLuLuRelationTypesForLuType in interface LuService

Parameters:: luTypeKey - Key of the first LU Type; relatedLuTypeKey - Key of the second LU Type
Returns:: list of LU to LU relation types
Throws:: DoesNotExistException - luTypeKey, relatedLuTypeKey not found; InvalidParameterException - invalid luTypeKey, relatedLuTypeKey; MissingParameterException - missing luTypeKey, relatedLuTypeKey; OperationFailedException - unable to complete request

getLuPublicationTypes

public List<LuPublicationTypeInfo> getLuPublicationTypes()
                                                  throws OperationFailedException

Description copied from interface: LuService

Retrieves the list of Learning Unit publication types

Specified by:: getLuPublicationTypes in interface LuService

Returns:: list of Learning Unit publication type information
Throws:: OperationFailedException - unable to complete request

getLuPublicationType

public LuPublicationTypeInfo getLuPublicationType(String luPublicationTypeKey)
                                           throws DoesNotExistException,
                                                  InvalidParameterException,
                                                  MissingParameterException,
                                                  OperationFailedException

Description copied from interface: LuService

Retrieves information about a publication type

Specified by:: getLuPublicationType in interface LuService

Parameters:: luPublicationTypeKey - Key of the Learning Unit Publication Type
Returns:: information about a Learning Unit Publication Type
Throws:: DoesNotExistException - luPublicationType not found; InvalidParameterException - invalid luPublicationType; MissingParameterException - missing luPublicationType; OperationFailedException - unable to complete request

getLuPublicationTypesForLuType

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

Description copied from interface: LuService

Retrieves information about a publication type

Specified by:: getLuPublicationTypesForLuType in interface LuService

Parameters:: luTypeKey - Key of the LU Type
Returns:: list of LU publication types
Throws:: DoesNotExistException - luPublicationType not found; InvalidParameterException - invalid luPublicationType; MissingParameterException - missing luPublicationType; OperationFailedException - unable to complete request

getCluResultTypes

public List<CluResultTypeInfo> getCluResultTypes()
                                          throws OperationFailedException

Description copied from interface: LuService

Retrieves a list of types for clu result objects.

Specified by:: getCluResultTypes in interface LuService

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

getCluResultType

public CluResultTypeInfo getCluResultType(String cluResultTypeKey)
                                   throws DoesNotExistException,
                                          InvalidParameterException,
                                          MissingParameterException,
                                          OperationFailedException

Description copied from interface: LuService

Retrieves information about a publication type

Specified by:: getCluResultType in interface LuService

Parameters:: cluResultTypeKey - Key of the Canonical Learning Unit Result Type
Returns:: information about a Learning Unit Publication Type
Throws:: DoesNotExistException - luPublicationType not found; InvalidParameterException - invalid luPublicationType; MissingParameterException - missing luPublicationType; OperationFailedException - unable to complete request

getCluResultTypesForLuType

public List<CluResultTypeInfo> getCluResultTypesForLuType(String luTypeKey)
                                                   throws DoesNotExistException,
                                                          InvalidParameterException,
                                                          MissingParameterException,
                                                          OperationFailedException

Description copied from interface: LuService

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 LuService

Parameters:: luTypeKey - luTypeKey
Returns:: list of clu result types
Throws:: DoesNotExistException - luTypeKey not found; InvalidParameterException - invalid luTypeKey; MissingParameterException - missing luTypeKey; OperationFailedException - unable to complete request

getResultUsageTypes

public List<ResultUsageTypeInfo> getResultUsageTypes()
                                              throws OperationFailedException

Description copied from interface: LuService

Retrieves a list of result usage types

Specified by:: getResultUsageTypes in interface LuService

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

getResultUsageType

public ResultUsageTypeInfo getResultUsageType(String resultUsageTypeKey)
                                       throws DoesNotExistException,
                                              InvalidParameterException,
                                              MissingParameterException,
                                              OperationFailedException

Description copied from interface: LuService

Retrieves information about a Result Usage Type

Specified by:: getResultUsageType in interface LuService

Parameters:: resultUsageTypeKey - Key of the Result Usage Type
Returns:: information about a Result Usage Type
Throws:: DoesNotExistException - resultUsageTypeKey not found; InvalidParameterException - invalid resultUsageTypeKey; MissingParameterException - missing resultUsageTypeKey; OperationFailedException - unable to complete request

getAllowedResultUsageTypesForLuType

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

Description copied from interface: LuService

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

Specified by:: getAllowedResultUsageTypesForLuType in interface LuService

Parameters:: luTypeKey - luTypeKey
Returns:: list of result usage types
Throws:: DoesNotExistException - luTypeKey not found; InvalidParameterException - invalid luTypeKey; MissingParameterException - missing luTypeKey; OperationFailedException - unable to complete request

getAllowedResultComponentTypesForResultUsageType

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

Description copied from interface: LuService

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

Specified by:: getAllowedResultComponentTypesForResultUsageType in interface LuService

Parameters:: resultUsageTypeKey - resultUsageTypeKey
Returns:: list of result component types
Throws:: DoesNotExistException - resultUsageTypeKey not found; InvalidParameterException - invalid resultUsageTypeKey; MissingParameterException - missing resultUsageTypeKey; OperationFailedException - unable to complete request

getCluLoRelationType

public CluLoRelationTypeInfo getCluLoRelationType(String cluLoRelationTypeKey)
                                           throws DoesNotExistException,
                                                  InvalidParameterException,
                                                  MissingParameterException,
                                                  OperationFailedException

Description copied from interface: LuService

Retrieves information for a specified CLU to LO relation type

Specified by:: getCluLoRelationType in interface LuService

Parameters:: cluLoRelationTypeKey - Key of the CLU to LO Relation Type
Returns:: CLU to LO relation type information
Throws:: DoesNotExistException - cluLoRelationTypeKey not found; InvalidParameterException - invalid cluLoRelationTypeKey; MissingParameterException - missing cluLoRelationTypeKey; OperationFailedException - unable to complete request

getCluLoRelationTypes

public List<CluLoRelationTypeInfo> getCluLoRelationTypes()
                                                  throws OperationFailedException

Description copied from interface: LuService

Retrieves the complete list of CLU to LO relation types

Specified by:: getCluLoRelationTypes in interface LuService

Returns:: list of CLU to LO relation type information
Throws:: OperationFailedException - unable to complete request

getAllowedCluLoRelationTypesForLuType

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

Description copied from interface: LuService

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 LuService

Parameters:: luTypeKey - luTypeKey
Returns:: list of clu lo relation types
Throws:: DoesNotExistException - luTypeKey not found; InvalidParameterException - invalid luTypeKey; MissingParameterException - missing luTypeKey; OperationFailedException - unable to complete request

getCluSetTypes

public List<CluSetTypeInfo> getCluSetTypes()
                                    throws OperationFailedException

Description copied from interface: LuService

Retrieves the list of CLU set types known by the service

Specified by:: getCluSetTypes in interface LuService

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

getCluSetType

public CluSetTypeInfo getCluSetType(String cluSetTypeKey)
                             throws DoesNotExistException,
                                    InvalidParameterException,
                                    MissingParameterException,
                                    OperationFailedException

Description copied from interface: LuService

Retrieves information about a specified CLU set type

Specified by:: getCluSetType in interface LuService

Parameters:: cluSetTypeKey - Key of the CLU set type
Returns:: information about a CLU set type
Throws:: DoesNotExistException - cluSetTypeKey not found; InvalidParameterException - invalid cluSetTypeKey; MissingParameterException - missing cluSetTypeKey; OperationFailedException - unable to complete request

getClu

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

READ OPERATION *

Specified by:: getClu in interface LuService

Parameters:: cluId - identifier of the CLU
Returns:: information about a CLU
Throws:: DoesNotExistException - cluId not found; InvalidParameterException - invalid cluId; MissingParameterException - missing cluId; OperationFailedException - unable to complete request

getClusByIdList

public List<CluInfo> getClusByIdList(List<String> cluIdList)
                              throws DoesNotExistException,
                                     InvalidParameterException,
                                     MissingParameterException,
                                     OperationFailedException

Description copied from interface: LuService

Retrieves information about CLUs from a list of ids

Specified by:: getClusByIdList in interface LuService

Parameters:: cluIdList - List of CLU identifiers
Returns:: information a list of CLUs
Throws:: DoesNotExistException - One or more cluIds not found; InvalidParameterException - One or more invalid cluIds; MissingParameterException - missing cluIdList; OperationFailedException - unable to complete request

getClusByLuType

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

Description copied from interface: LuService

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

Specified by:: getClusByLuType in interface LuService

Parameters:: luTypeKey - Type of the CLUs to retrieve; luState - State of the CLUs to retrieve.
Returns:: list of CLU information
Throws:: DoesNotExistException - luType or luState not found; InvalidParameterException - invalid luType or luState; MissingParameterException - missing luType or luState; OperationFailedException - unable to complete request

getCluIdsByLuType

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

Description copied from interface: LuService

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

Specified by:: getCluIdsByLuType in interface LuService

Parameters:: luTypeKey - Type of the CLUs whose identifiers should be retrieved; luState - State of the CLUs whose identifiers should be retrieved
Returns:: list of CLU identifiers
Throws:: DoesNotExistException - luType or luState not found; InvalidParameterException - invalid luType or luState; MissingParameterException - missing luType or luState; OperationFailedException - unable to complete request

getAllowedLuLuRelationTypesByCluId

public List<String> getAllowedLuLuRelationTypesByCluId(String cluId,
                                                       String relatedCluId)
                                                throws DoesNotExistException,
                                                       InvalidParameterException,
                                                       MissingParameterException,
                                                       OperationFailedException

Description copied from interface: LuService

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

Specified by:: getAllowedLuLuRelationTypesByCluId in interface LuService

Parameters:: cluId - identifier of the first CLU; relatedCluId - identifier of the second CLU
Returns:: list of LU to LU relation types
Throws:: DoesNotExistException - clu, relatedClu not found; InvalidParameterException - invalid cluId, relatedCluId; MissingParameterException - missing cluId, relatedCluId; OperationFailedException - unable to complete request

getClusByRelation

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

Description copied from interface: LuService

Retrieves the list of CLU information for the CLUs related to a specified CLU Id with a certain LU to LU relation type (getRelatedClusByCluId from the other direction)

Specified by:: getClusByRelation in interface LuService

Parameters:: relatedCluId - identifier of the child or To CLU; luLuRelationTypeKey - the LU to LU relation type
Returns:: list of CLU information
Throws:: DoesNotExistException - relatedCluId, luLuRelationType not found; InvalidParameterException - invalid relatedCluId, luLuRelationType; MissingParameterException - missing relatedCluId, luLuRelationType; OperationFailedException - unable to complete request

getCluIdsByRelation

public List<String> getCluIdsByRelation(String relatedCluId,
                                        String luLuRelationTypeKey)
                                 throws DoesNotExistException,
                                        InvalidParameterException,
                                        MissingParameterException,
                                        OperationFailedException

Description copied from interface: LuService

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

Specified by:: getCluIdsByRelation in interface LuService

Parameters:: relatedCluId - identifier of the child or To CLU; luLuRelationTypeKey - the LU to LU relation type
Returns:: list of CLU identifiers
Throws:: DoesNotExistException - relatedClu, luLuRelationType not found; InvalidParameterException - invalid relatedCluId, luLuRelationType; MissingParameterException - missing relatedCluId, luLuRelationType; OperationFailedException - unable to complete request

getRelatedClusByCluId

public List<CluInfo> getRelatedClusByCluId(String cluId,
                                           String luLuRelationTypeKey)
                                    throws DoesNotExistException,
                                           InvalidParameterException,
                                           MissingParameterException,
                                           OperationFailedException

Description copied from interface: LuService

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:: getRelatedClusByCluId in interface LuService

Parameters:: cluId - identifier of the parent or From CLU; luLuRelationTypeKey - the LU to LU relation type
Returns:: list of CLU information
Throws:: DoesNotExistException - clu, luLuRelationType not found; InvalidParameterException - invalid cluId, luLuRelationType; MissingParameterException - missing cluId, luLuRelationType; OperationFailedException - unable to complete request

getRelatedCluIdsByCluId

public List<String> getRelatedCluIdsByCluId(String cluId,
                                            String luLuRelationTypeKey)
                                     throws DoesNotExistException,
                                            InvalidParameterException,
                                            MissingParameterException,
                                            OperationFailedException

Description copied from interface: LuService

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

Specified by:: getRelatedCluIdsByCluId in interface LuService

Parameters:: cluId - identifier of the parent or From CLU; luLuRelationTypeKey - the LU to LU relation type
Returns:: list of CLU identifiers
Throws:: DoesNotExistException - clu, luLuRelationType not found; InvalidParameterException - invalid cluId, luLuRelationType; MissingParameterException - missing cluId, luLuRelationType; OperationFailedException - unable to complete request

getCluCluRelation

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

Description copied from interface: LuService

Retrieves the relationship information between CLUs for a particular Relation instance

Specified by:: getCluCluRelation in interface LuService

Parameters:: cluCluRelationId - identifier of the CLU to CLU relation
Returns:: information on the relation between two CLUs
Throws:: DoesNotExistException - cluCluRelation not found; InvalidParameterException - invalid cluCluRelationId; MissingParameterException - missing cluCluRelationId; OperationFailedException - unable to complete request

getCluCluRelationsByClu

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

Description copied from interface: LuService

Retrieves the list of relationship information for the specified CLU

Specified by:: getCluCluRelationsByClu in interface LuService

Parameters:: cluId - identifier of the parent or From CLU
Returns:: list of CLU to CLU relation information
Throws:: DoesNotExistException - clu not found; InvalidParameterException - invalid cluId; MissingParameterException - missing cluId; OperationFailedException - unable to complete request

getCluPublicationsByCluId

public List<CluPublicationInfo> getCluPublicationsByCluId(String cluId)
                                                   throws DoesNotExistException,
                                                          InvalidParameterException,
                                                          MissingParameterException,
                                                          OperationFailedException

Description copied from interface: LuService

Retrieves a list of publication objects for a particular clu

Specified by:: getCluPublicationsByCluId in interface LuService

Parameters:: cluId - clu identifier
Returns:: list of publication objects used by the specified clu
Throws:: DoesNotExistException - clu not found; InvalidParameterException - invalid cluId; MissingParameterException - cluId not specified; OperationFailedException - unable to complete request

getCluPublicationsByType

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

Description copied from interface: LuService

Retrieves a list of publication objects of a particular Type

Specified by:: getCluPublicationsByType in interface LuService

Parameters:: luPublicationTypeKey - luPublicationType identifier
Returns:: list of CLU Publication objects using the specified type
Throws:: DoesNotExistException - luPublicationType not found; InvalidParameterException - invalid luPublicationTypeKey; MissingParameterException - luPublicationTypeKey not specified; OperationFailedException - unable to complete request

getCluPublication

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

Description copied from interface: LuService

Retrieves an LU publication object by its identifier

Specified by:: getCluPublication in interface LuService

Parameters:: cluPublicationId - CLU publication identifier
Returns:: CLU Publication information
Throws:: DoesNotExistException - CLU Publication not found; InvalidParameterException - invalid cluPublicationId; MissingParameterException - cluPublicationId not specified; OperationFailedException - unable to complete request

getCluResult

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

Description copied from interface: LuService

Retrieves information about a Clu Result

Specified by:: getCluResult in interface LuService

Parameters:: cluResultId - identifier of the Clu Result
Returns:: information about a Clu Result
Throws:: DoesNotExistException - cluResult not found; InvalidParameterException - invalid cluResultId; MissingParameterException - missing cluResultId; OperationFailedException - unable to complete request

getCluResultByClu

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

Description copied from interface: LuService

Retrieves the cluResult for a particular clu

Specified by:: getCluResultByClu in interface LuService

Parameters:: cluId - clu identifier
Returns:: result information for a clu
Throws:: DoesNotExistException - clu not found; InvalidParameterException - invalid cluId; MissingParameterException - cluId not specified; OperationFailedException - unable to complete request

getCluIdsByResultUsageType

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

Description copied from interface: LuService

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 LuService

Parameters:: resultUsageTypeKey - identifier of the result usage type
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)
                                        throws DoesNotExistException,
                                               InvalidParameterException,
                                               MissingParameterException,
                                               OperationFailedException

Description copied from interface: LuService

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

Specified by:: getCluIdsByResultComponent in interface LuService

Parameters:: resultComponentId - identifier of the result component
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)
                                   throws DoesNotExistException,
                                          InvalidParameterException,
                                          MissingParameterException,
                                          OperationFailedException,
                                          PermissionDeniedException

Description copied from interface: LuService

Retrieve information on a CLU LO Relation.

Specified by:: getCluLoRelation in interface LuService

Parameters:: cluLoRelationId - Identifier of the CLU LO Relation
Returns:: The retrieved CLU LO Relation information
Throws:: DoesNotExistException - cluLoRelation not found; InvalidParameterException - invalid cluLoRelationId; MissingParameterException - missing cluLoRelationId; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

getCluLoRelationsByClu

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

Description copied from interface: LuService

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

Specified by:: getCluLoRelationsByClu in interface LuService

Parameters:: cluId - Identifier for the CLU
Returns:: List of canonical learning unit to learning objective relationships
Throws:: DoesNotExistException - clu not found; InvalidParameterException - invalid cluId; MissingParameterException - missing cluId; OperationFailedException - unable to complete request

getCluLoRelationsByLo

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

Description copied from interface: LuService

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

Specified by:: getCluLoRelationsByLo in interface LuService

Parameters:: loId - Identifier for the learning objective
Returns:: List of CLU LO Relations
Throws:: DoesNotExistException - lo not found; InvalidParameterException - invalid loId; MissingParameterException - missing loId; OperationFailedException - unable to complete request

getResourceRequirementsForCluId

public List<String> getResourceRequirementsForCluId(String cluId)
                                             throws DoesNotExistException,
                                                    InvalidParameterException,
                                                    MissingParameterException,
                                                    OperationFailedException

Description copied from interface: LuService

Retrieves the list of Resource requirements for the specified CLU

Specified by:: getResourceRequirementsForCluId in interface LuService

Parameters:: cluId - Unique identifier for the CLU
Returns:: List of resource requirements
Throws:: DoesNotExistException - clu not found; InvalidParameterException - cluId invalid; MissingParameterException - cluId missing; OperationFailedException - unable to complete request

getCluSetInfo

public CluSetInfo getCluSetInfo(String cluSetId)
                         throws DoesNotExistException,
                                InvalidParameterException,
                                MissingParameterException,
                                OperationFailedException,
                                PermissionDeniedException

Description copied from interface: LuService

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:: getCluSetInfo in interface LuService

Parameters:: cluSetId - Identifier of the CLU set
Returns:: The retrieved CLU set information
Throws:: DoesNotExistException - cluSet not found; InvalidParameterException - invalid cluSetId; MissingParameterException - missing cluSetId; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

getCluSetTreeView

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

Description copied from interface: LuService

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

Specified by:: getCluSetTreeView in interface LuService

Parameters:: cluSetId - Identifier of the CLU set
Returns:: The retrieved CLU set tree view information
Throws:: DoesNotExistException - cluSet not found; InvalidParameterException - invalid cluSetId; MissingParameterException - missing cluSetId; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

getCluSetTreeViewHelper

private void getCluSetTreeViewHelper(CluSetInfo cluSetInfo,
                                     CluSetTreeViewInfo cluSetTreeViewInfo)
                              throws DoesNotExistException,
                                     InvalidParameterException,
                                     MissingParameterException,
                                     OperationFailedException,
                                     PermissionDeniedException

Go through the list of CluSets and retrieve all the information regarding child Clu Sets and associated Clus

Parameters:: cluSetInfo -; cluSetTreeViewInfo -
Throws:: DoesNotExistException; InvalidParameterException; MissingParameterException; OperationFailedException; PermissionDeniedException

getCluSetInfoByIdList

public List<CluSetInfo> getCluSetInfoByIdList(List<String> cluSetIdList)
                                       throws DoesNotExistException,
                                              InvalidParameterException,
                                              MissingParameterException,
                                              OperationFailedException,
                                              PermissionDeniedException

Description copied from interface: LuService

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

Specified by:: getCluSetInfoByIdList in interface LuService

Parameters:: cluSetIdList - List of identifiers of CLU sets
Returns:: The retrieved list of CLU set information
Throws:: DoesNotExistException - One or more cluSets not found; InvalidParameterException - One or more cluSetIds invalid; MissingParameterException - missing cluSetIdList; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

getCluSetIdsFromCluSet

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

Description copied from interface: LuService

Retrieve the list of CLU Set Ids within a CLU Set

Specified by:: getCluSetIdsFromCluSet in interface LuService

Parameters:: cluSetId - Identifier of the CLU set
Returns:: The retrieved list of CLU Set Ids within the specified CLU set
Throws:: DoesNotExistException - cluSet not found; InvalidParameterException - invalid cluSetId; MissingParameterException - missing cluSetId; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

isCluSetDynamic

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

Description copied from interface: LuService

Check if the given CluSet is dynamic

Specified by:: isCluSetDynamic in interface LuService

Parameters:: cluSetId - Identifier of the CLU set
Returns:: The retrieved list of CLU Set Ids within the specified CLU set
Throws:: DoesNotExistException - cluSet not found; InvalidParameterException - invalid cluSetId; MissingParameterException - missing cluSetId; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

getClusFromCluSet

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

Description copied from interface: LuService

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

Specified by:: getClusFromCluSet in interface LuService

Parameters:: cluSetId - Identifier of the CLU set
Returns:: The retrieved list of information on the CLUs within the CLU set (flattened and de-duped)
Throws:: DoesNotExistException - cluSet not found; InvalidParameterException - invalid cluSetId; MissingParameterException - missing cluSetId; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

getCluIdsFromCluSet

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

Description copied from interface: LuService

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

Specified by:: getCluIdsFromCluSet in interface LuService

Parameters:: cluSetId - Identifier of the CLU set
Returns:: The retrieved list of CLU Ids within the specified CLU set (flattened and de-duped)
Throws:: DoesNotExistException - cluSet not found; InvalidParameterException - invalid cluSetId; MissingParameterException - missing cluSetId; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

getAllClusInCluSet

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

Description copied from interface: LuService

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

Specified by:: getAllClusInCluSet in interface LuService

Parameters:: cluSetId - Identifier of the CLU set
Returns:: The retrieved list of information on the CLUs
Throws:: DoesNotExistException - cluSet not found; InvalidParameterException - invalid cluSetId; MissingParameterException - missing cluSetId; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

getAllCluIdsInCluSet

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

Description copied from interface: LuService

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

Specified by:: getAllCluIdsInCluSet in interface LuService

Parameters:: cluSetId - Identifier of the CLU set
Returns:: The retrieved list of CLU Ids within the specified CLU set
Throws:: DoesNotExistException - cluSet not found; InvalidParameterException - invalid cluSetId; MissingParameterException - missing cluSetId; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

isCluInCluSet

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

Description copied from interface: LuService

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

Specified by:: isCluInCluSet in interface LuService

Parameters:: cluId - Identifier of the CLU to check; cluSetId - Identifier of the CLU set
Returns:: True if the CLU is a member of the CLU Set
Throws:: DoesNotExistException - clu, cluSet not found; InvalidParameterException - invalid cluId, cluSetId; MissingParameterException - missing cluId, cluSetId; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

getLui

public LuiInfo getLui(String luiId)
               throws DoesNotExistException,
                      InvalidParameterException,
                      MissingParameterException,
                      OperationFailedException

Description copied from interface: LuService

Retrieves information about a LUI

Specified by:: getLui in interface LuService

Parameters:: luiId - identifier of the LUI
Returns:: information about a LUI
Throws:: DoesNotExistException - lui not found; InvalidParameterException - invalid luiId; MissingParameterException - missing luiId; OperationFailedException - unable to complete request

getLuisByIdList

public List<LuiInfo> getLuisByIdList(List<String> luiIdList)
                              throws DoesNotExistException,
                                     InvalidParameterException,
                                     MissingParameterException,
                                     OperationFailedException

Description copied from interface: LuService

Retrieves information about LUIs from a list of Ids

Specified by:: getLuisByIdList in interface LuService

Parameters:: luiIdList - List of LUI identifiers
Returns:: information about a list of LUIs
Throws:: DoesNotExistException - One or more luis not found; InvalidParameterException - One or more invalid luiIds; MissingParameterException - missing luiIdList; OperationFailedException - unable to complete request

getLuisInAtpByCluId

public List<LuiInfo> getLuisInAtpByCluId(String cluId,
                                         String atpKey)
                                  throws DoesNotExistException,
                                         InvalidParameterException,
                                         MissingParameterException,
                                         OperationFailedException

Description copied from interface: LuService

Retrieves the list of LUIs for the specified CLU and period

Specified by:: getLuisInAtpByCluId in interface LuService

Parameters:: cluId - identifier of the CLU; atpKey - identifier for the academic time period
Returns:: list of LUI information
Throws:: DoesNotExistException - clu, atp not found; InvalidParameterException - invalid cluId, atpKey; MissingParameterException - missing cluId, atpKey; OperationFailedException - unable to complete request

getLuiIdsByCluId

public List<String> getLuiIdsByCluId(String cluId)
                              throws DoesNotExistException,
                                     InvalidParameterException,
                                     MissingParameterException,
                                     OperationFailedException

Description copied from interface: LuService

Retrieves the list of LUI ids for the specified CLU

Specified by:: getLuiIdsByCluId in interface LuService

Parameters:: cluId - identifier of the CLU
Returns:: list of LUI identifiers
Throws:: DoesNotExistException - clu not found; InvalidParameterException - invalid cluId; MissingParameterException - missing cluId; OperationFailedException - unable to complete request

getLuiIdsInAtpByCluId

public List<String> getLuiIdsInAtpByCluId(String cluId,
                                          String atpKey)
                                   throws DoesNotExistException,
                                          InvalidParameterException,
                                          MissingParameterException,
                                          OperationFailedException

Description copied from interface: LuService

Retrieves the list of LUI ids for the specified CLU and Time period

Specified by:: getLuiIdsInAtpByCluId in interface LuService

Parameters:: cluId - identifier of the CLU; atpKey - identifier for the academic time period
Returns:: list of LUI identifiers
Throws:: DoesNotExistException - clu, atp not found; InvalidParameterException - invalid cluId, atpKey; MissingParameterException - missing cluId, atpKey; OperationFailedException - unable to complete request

getAllowedLuLuRelationTypesByLuiId

public List<String> getAllowedLuLuRelationTypesByLuiId(String luiId,
                                                       String relatedLuiId)
                                                throws DoesNotExistException,
                                                       InvalidParameterException,
                                                       MissingParameterException,
                                                       OperationFailedException

Description copied from interface: LuService

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

Specified by:: getAllowedLuLuRelationTypesByLuiId in interface LuService

Parameters:: luiId - identifier of the first LUI; relatedLuiId - identifier of the second LUI
Returns:: list of LU to LU relation types
Throws:: DoesNotExistException - lui, relatedLui not found; InvalidParameterException - invalid luiId, relatedLuiId; MissingParameterException - missing luiId, relatedLuiId; OperationFailedException - unable to complete request

getLuisByRelation

public List<LuiInfo> getLuisByRelation(String luiId,
                                       String luLuRelationTypeKey)
                                throws DoesNotExistException,
                                       InvalidParameterException,
                                       MissingParameterException,
                                       OperationFailedException

Description copied from interface: LuService

Retrieves the list of LUI information for the LUIs related to the specified LUI Id with a certain LU to LU relation type (getRelatedLuisByLuiId from the other direction)

Specified by:: getLuisByRelation in interface LuService

Parameters:: luiId - identifier of the LUI; luLuRelationTypeKey - the LU to LU relation type
Returns:: list of LUI information
Throws:: DoesNotExistException - relatedLui, luLuRelationType not found; InvalidParameterException - invalid relatedLuiId, luLuRelationType; MissingParameterException - missing relatedLuiId, luLuRelationType; OperationFailedException - unable to complete request

getLuiIdsByRelation

public List<String> getLuiIdsByRelation(String luiId,
                                        String luLuRelationTypeKey)
                                 throws DoesNotExistException,
                                        InvalidParameterException,
                                        MissingParameterException,
                                        OperationFailedException

Description copied from interface: LuService

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

Specified by:: getLuiIdsByRelation in interface LuService

Parameters:: luiId - identifier of the LUI; luLuRelationTypeKey - the LU to LU relation type
Returns:: list of LUI identifiers
Throws:: DoesNotExistException - relatedLui, luLuRelationType not found; InvalidParameterException - invalid relatedLuiId, luLuRelationType; MissingParameterException - missing relatedLuiId, luLuRelationType; OperationFailedException - unable to complete request

getRelatedLuisByLuiId

public List<LuiInfo> getRelatedLuisByLuiId(String luiId,
                                           String luLuRelationTypeKey)
                                    throws DoesNotExistException,
                                           InvalidParameterException,
                                           MissingParameterException,
                                           OperationFailedException

Description copied from interface: LuService

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

Specified by:: getRelatedLuisByLuiId in interface LuService

Parameters:: luiId - identifier of the LUI; luLuRelationTypeKey - the LU to LU relation type
Returns:: list of LUI information
Throws:: DoesNotExistException - lui, luLuRelationType not found; InvalidParameterException - invalid luiId, luLuRelationType; MissingParameterException - missing luiId, luLuRelationType; OperationFailedException - unable to complete request

getRelatedLuiIdsByLuiId

public List<String> getRelatedLuiIdsByLuiId(String luiId,
                                            String luLuRelationTypeKey)
                                     throws DoesNotExistException,
                                            InvalidParameterException,
                                            MissingParameterException,
                                            OperationFailedException

Description copied from interface: LuService

Retrieves the list of related LUI Ids for the specified LUI Id and LU to LU relation type. (getLuiIdsByRelation from the other direction)

Specified by:: getRelatedLuiIdsByLuiId in interface LuService

Parameters:: luiId - identifier of the LUI; luLuRelationTypeKey - the LU to LU relation type
Returns:: list of LUI identifiers
Throws:: DoesNotExistException - luiId, luLuRelationType not found; InvalidParameterException - invalid luiId, luLuRelationType; MissingParameterException - missing luiId, luLuRelationType; OperationFailedException - unable to complete request

getLuiLuiRelation

public LuiLuiRelationInfo getLuiLuiRelation(String luiLuiRelationId)
                                     throws DoesNotExistException,
                                            InvalidParameterException,
                                            MissingParameterException,
                                            OperationFailedException

Description copied from interface: LuService

Retrieves the relationship information between LUIs given a specific relation instance

Specified by:: getLuiLuiRelation in interface LuService

Parameters:: luiLuiRelationId - identifier of LUI to LUI relation
Returns:: information on the relation between two LUIs
Throws:: DoesNotExistException - luiLuiRelation not found; InvalidParameterException - invalid luiLuiRelationId; MissingParameterException - missing luiLuiRelationId; OperationFailedException - unable to complete request

getLuiLuiRelationsByLui

public List<LuiLuiRelationInfo> getLuiLuiRelationsByLui(String luiId)
                                                 throws DoesNotExistException,
                                                        InvalidParameterException,
                                                        MissingParameterException,
                                                        OperationFailedException

Description copied from interface: LuService

Retrieves the list of relationship information for the specified LUI

Specified by:: getLuiLuiRelationsByLui in interface LuService

Parameters:: luiId - identifier of the LUI
Returns:: list of LUI to LUI relation information
Throws:: DoesNotExistException - lui not found; InvalidParameterException - invalid luiId; MissingParameterException - missing luiId; OperationFailedException - unable to complete request

validateClu

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

MAINTENANCE OPERATIONS *

Specified by:: validateClu in interface LuService

Parameters:: validationType - identifier of the extent of validation; cluInfo - CLU information to be tested.
Returns:: results from performing the validation
Throws:: DoesNotExistException - validationTypeKey not found; InvalidParameterException - invalid validationTypeKey, cluInfo; MissingParameterException - missing validationTypeKey, cluInfo; OperationFailedException - unable to complete request

createClu

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

Description copied from interface: LuService

Creates a new CLU

Specified by:: createClu in interface LuService

Parameters:: luTypeKey - identifier of the LU Type for the CLU being created; cluInfo - information about the CLU being created
Returns:: the created CLU information
Throws:: AlreadyExistsException - CLU already exists; DataValidationErrorException - One or more values invalid for this operation; DoesNotExistException - luTypeKey not found; InvalidParameterException - invalid luTypeKey, cluInfo; MissingParameterException - missing luTypeKey, cluInfo; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

toCluForCreate

public Clu toCluForCreate(String luTypeKey,
                          CluInfo cluInfo)
                   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)
                  throws DataValidationErrorException,
                         DoesNotExistException,
                         InvalidParameterException,
                         MissingParameterException,
                         OperationFailedException,
                         PermissionDeniedException,
                         VersionMismatchException

Description copied from interface: LuService

Updates an existing CLU

Specified by:: updateClu in interface LuService

Parameters:: cluId - identifier for the CLU to be updated; cluInfo - updated information about the CLU
Returns:: the updated CLU information
Throws:: DataValidationErrorException - One or more values invalid for this operation; DoesNotExistException - cluId not found; InvalidParameterException - invalid cluId, cluInfo; MissingParameterException - missing cluId, cluInfo; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure; VersionMismatchException - The action was attempted on an out of date version

deleteClu

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

Description copied from interface: LuService

Deletes an existing CLU

Specified by:: deleteClu in interface LuService

Parameters:: cluId - identifier for the CLU to be deleted
Returns:: status of the operation
Throws:: DoesNotExistException - cluId not found; InvalidParameterException - invalid cluId; MissingParameterException - missing cluId; 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)
                       throws DataValidationErrorException,
                              DoesNotExistException,
                              InvalidParameterException,
                              MissingParameterException,
                              OperationFailedException,
                              PermissionDeniedException

Description copied from interface: LuService

Updates the state of the specified CLU

Specified by:: updateCluState in interface LuService

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.
Returns:: the updated CLU information
Throws:: DataValidationErrorException - new state not valid for existing state of CLU; DoesNotExistException - cluId, luState not found; InvalidParameterException - invalid cluId, luState; MissingParameterException - missing cluId, luState; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

validateCluCluRelation

public List<ValidationResultInfo> validateCluCluRelation(String validationType,
                                                         CluCluRelationInfo cluCluRelationInfo)
                                                  throws DoesNotExistException,
                                                         InvalidParameterException,
                                                         MissingParameterException,
                                                         OperationFailedException

Description copied from interface: LuService

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 LuService

Parameters:: validationType - identifier of the extent of validation; cluCluRelationInfo - cluCluRelation information to be tested.
Returns:: results from performing the validation
Throws:: DoesNotExistException - validationTypeKey not found; InvalidParameterException - invalid validationTypeKey, cluCluRelationInfo; MissingParameterException - missing validationTypeKey, cluCluRelationInfo; OperationFailedException - unable to complete request

createCluCluRelation

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

Description copied from interface: LuService

Create a directional relationship between two CLUs

Specified by:: createCluCluRelation in interface LuService

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
Returns:: the created CLU to CLU relation information
Throws:: AlreadyExistsException - relationship already exists; DataValidationErrorException - One or more values invalid for this operation; DoesNotExistException - cluId, relatedCluId, luLuRelationType not found; InvalidParameterException - invalid cluId, relatedCluId, luluRelationType, cluCluRelationInfo; MissingParameterException - missing cluId, relatedCluId, luluRelationType, cluCluRelationInfo; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure; CircularRelationshipException - cluId equals relatedCluId

updateCluCluRelation

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

Description copied from interface: LuService

Updates a relationship between two CLUs

Specified by:: updateCluCluRelation in interface LuService

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

deleteCluCluRelation

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

Description copied from interface: LuService

Deletes a relationship between two CLUs

Specified by:: deleteCluCluRelation in interface LuService

Parameters:: cluCluRelationId - identifier of CLU to CLU relationship to delete
Returns:: status of the operation (success or failure)
Throws:: DoesNotExistException - cluCluRelation not found; InvalidParameterException - invalid cluCluRelationId; MissingParameterException - missing cluCluRelationId; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

validateCluPublication

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

Description copied from interface: LuService

Validates information about publication for a clu. Depending on the value of validationType, this validation could be limited to tests on just the current object and its directly contained sub-objects or expanded to perform all tests related to this object. If an identifier is present for the clu 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 validationType to the current object.

Specified by:: validateCluPublication in interface LuService

Parameters:: validationType - identifier of the extent of validation; cluPublicationInfo - CLU publication information to be tested.
Returns:: results from performing the validation
Throws:: DoesNotExistException - validationTypeKey not found; InvalidParameterException - invalid validationTypeKey, cluPublicationInfo; MissingParameterException - missing validationTypeKey, cluPublicationInfo; OperationFailedException - unable to complete request

createCluPublication

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

Description copied from interface: LuService

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

Specified by:: createCluPublication in interface LuService

Parameters:: cluId - identifier of a clu; luPublicationType - type of lu publication; cluPublicationInfo - information about publication for a clu
Returns:: information about the created clu publication object
Throws:: AlreadyExistsException - clu publication object already exists; DataValidationErrorException - One or more values invalid for this operation; InvalidParameterException - invalid cluId, luPublicationType, cluPublicationInfo; MissingParameterException - missing cluId, luPublicationType, cluPublicationInfo; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

updateCluPublication

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

Description copied from interface: LuService

Updates an existing clu publication object

Specified by:: updateCluPublication in interface LuService

Parameters:: cluPublicationId - identifier for the clu publication object to be updated; cluPublicationInfo - updated information about the clu publication object
Returns:: the updated clu publication information
Throws:: DataValidationErrorException - One or more values invalid for this operation; DoesNotExistException - cluPublication not found; InvalidParameterException - invalid cluPublicationId, cluPublicationInfo; MissingParameterException - missing cluPublicationId, cluPublicationInfo; 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)
                                throws DoesNotExistException,
                                       InvalidParameterException,
                                       MissingParameterException,
                                       DependentObjectsExistException,
                                       OperationFailedException,
                                       PermissionDeniedException

Description copied from interface: LuService

Deletes an existing clu publication object

Specified by:: deleteCluPublication in interface LuService

Parameters:: cluPublicationId - identifier for the clu publication object to be deleted
Returns:: status of the operation
Throws:: DoesNotExistException - cluPublication not found; InvalidParameterException - invalid cluPublicationId; MissingParameterException - missing cluPublicationId; 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,
                                                    CluResultInfo cluResultInfo)
                                             throws DoesNotExistException,
                                                    InvalidParameterException,
                                                    MissingParameterException,
                                                    OperationFailedException

Description copied from interface: LuService

Validates information about results for a clu. Depending on the value of validationType, this validation could be limited to tests on just the current object and its directly contained sub-objects or expanded to perform all tests related to this object. If an identifier is present for the clu 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 validationType to the current object.

Specified by:: validateCluResult in interface LuService

Parameters:: validationType - identifier of the extent of validation; cluResultInfo - CLU result information to be tested.
Returns:: results from performing the validation
Throws:: DoesNotExistException - validationTypeKey not found; InvalidParameterException - invalid validationTypeKey, cluResultInfo; MissingParameterException - missing validationTypeKey, cluResultInfo; OperationFailedException - unable to complete request

createCluResult

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

Description copied from interface: LuService

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

Specified by:: createCluResult in interface LuService

Parameters:: cluId - identifier of a clu; cluResultTypeKey - type of clu result; cluResultInfo - information about potential results for a clu
Returns:: information about the created clu result
Throws:: AlreadyExistsException - clu result already exists; DataValidationErrorException - One or more values invalid for this operation; InvalidParameterException - invalid cluId, cluResultType, cluResultInfo; MissingParameterException - missing cluId, cluResultType, cluResultInfo; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure; DoesNotExistException - resultUsageTypeKey not found

updateCluResult

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

Description copied from interface: LuService

Updates an existing clu result

Specified by:: updateCluResult in interface LuService

Parameters:: cluResultId - identifier for the clu result to be updated; cluResultInfo - updated information about the clu result
Returns:: the updated clu result information
Throws:: DataValidationErrorException - One or more values invalid for this operation; DoesNotExistException - cluResult not found; InvalidParameterException - invalid cluResultId, cluResultInfo; MissingParameterException - missing cluResultId, cluResultInfo; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure; VersionMismatchException - The action was attempted on an out of date version.

deleteCluResult

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

Description copied from interface: LuService

Deletes an existing clu result

Specified by:: deleteCluResult in interface LuService

Parameters:: cluResultId - identifier for the clu result to be deleted
Returns:: status of the operation
Throws:: DoesNotExistException - cluResult not found; InvalidParameterException - invalid cluResultId; MissingParameterException - missing cluResultId; 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,
                                                        CluLoRelationInfo cluLoRelationInfo)
                                                 throws DoesNotExistException,
                                                        InvalidParameterException,
                                                        MissingParameterException,
                                                        OperationFailedException

Description copied from interface: LuService

Validates a cluLoRelation. 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 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 validationType to the current object.

Specified by:: validateCluLoRelation in interface LuService

Parameters:: validationType - identifier of the extent of validation; cluLoRelationInfo - cluLoRelation information to be tested.
Returns:: results from performing the validation
Throws:: DoesNotExistException - validationTypeKey not found; InvalidParameterException - invalid validationTypeKey, cluLoRelationInfo; MissingParameterException - missing validationTypeKey, cluLoRelationInfo; OperationFailedException - unable to complete request

createCluLoRelation

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

Description copied from interface: LuService

Creates a relationship between a learning objective and a CLU.

Specified by:: createCluLoRelation in interface LuService

Parameters:: cluId - CLU identifier; loId - learning objective identifier; cluLoRelationType - type of clu learning objective relationship; cluLoRelationInfo - clu learning objective relationship information
Returns:: the newly created clu learning objective relationship
Throws:: AlreadyExistsException - connection between clu and learning objective already exists; DoesNotExistException - cluId, loId, cluLoRelationType not found; InvalidParameterException - one or more parameters invalid; MissingParameterException - one or more parameters not specified; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure; DataValidationErrorException - data validation error

updateCluLoRelation

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

Description copied from interface: LuService

Updates a relationship between a clu and learning objective

Specified by:: updateCluLoRelation in interface LuService

Parameters:: cluLoRelationId - identifier of the clu learning objective relationship to be updated; cluLoRelationInfo - information about the clu learning objective relationship to be updated
Returns:: the updated clu learning objective relationship information
Throws:: DataValidationErrorException - One or more values invalid for this operation; DoesNotExistException - cluLoRelation not found; InvalidParameterException - one or more parameters invalid; MissingParameterException - one or more parameters missing; 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)
                               throws DoesNotExistException,
                                      InvalidParameterException,
                                      MissingParameterException,
                                      OperationFailedException,
                                      PermissionDeniedException

Description copied from interface: LuService

Removes a relationship between a learning objective and a Clu.

Specified by:: deleteCluLoRelation in interface LuService

Parameters:: cluLoRelationId - CLU learning objective Relationship identifier
Returns:: Status
Throws:: DoesNotExistException - cluLoRelation not found; InvalidParameterException - invalid cluLoRelationId; MissingParameterException - cluLoRelationId not specified; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

addCluResourceRequirement

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

Description copied from interface: LuService

Add a Resource requirement to a CLU

Specified by:: addCluResourceRequirement in interface LuService

Parameters:: resourceTypeKey - identifier of the resource requirement type to be added to the CLU; cluId - identifier of the CLU
Returns:: status of the operation (success or failure)
Throws:: AlreadyExistsException - resourceTypeKey is already associated with the cluId; DoesNotExistException - resourceTypeKey or cluId not found; InvalidParameterException - resourceTypeKey or cluId invalid; MissingParameterException - resourceTypeKey or cluId missing; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

removeCluResourceRequirement

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

Description copied from interface: LuService

Remove a Resource requirement from a CLU

Specified by:: removeCluResourceRequirement in interface LuService

Parameters:: resourceTypeKey - identifier of the resource type to be removed from the CLU; cluId - identifier of the CLU
Returns:: status of the operation (success or failure)
Throws:: DoesNotExistException - resourceTypeKey or cluId or relationship not found; InvalidParameterException - resourceTypeKey or cluId invalid; MissingParameterException - resourceTypeKey or cluId missing; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

validateCluSet

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

Description copied from interface: LuService

Validates information about a clu set. Depending on the value of validationType, this validation could be limited to tests on just the current object and its directly contained sub-objects or expanded to perform all tests related to this object. If an identifier is present for the clu 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 LuService

Parameters:: validationType - identifier of the extent of validation; cluSetInfo - CLU set information to be tested.
Returns:: results from performing the validation
Throws:: DoesNotExistException - validationTypeKey not found; InvalidParameterException - invalid validationTypeKey, cluSetInfo; MissingParameterException - missing validationTypeKey, cluSetInfo; OperationFailedException - unable to complete request

createCluSet

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

Description copied from interface: LuService

Creates a CLU set.

Specified by:: createCluSet in interface LuService

Parameters:: cluSetType - type of the CLU set to be created; cluSetInfo - information required to create a CLU set
Returns:: the created CLU set information
Throws:: AlreadyExistsException - the cluSet already exists; DataValidationErrorException - One or more values invalid for this operation; InvalidParameterException - invalid cluSetName, cluSetInfo; MissingParameterException - missing cluSetName, cluSetInfo; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure; UnsupportedActionException - CLU set need to be static or dynamic but not both

setMembershipQuerySearchResult

private void setMembershipQuerySearchResult(CluSetInfo cluSetInfo)
                                     throws MissingParameterException

Throws:: MissingParameterException

getMembershipQuerySearchResult

private List<String> getMembershipQuerySearchResult(MembershipQueryInfo query)
                                             throws MissingParameterException

Throws:: MissingParameterException

validateCluSet

private void validateCluSet(CluSetInfo cluSetInfo)
                     throws UnsupportedActionException

Throws:: UnsupportedActionException

updateCluSet

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

Description copied from interface: LuService

Update the information for a CLU set

Specified by:: updateCluSet in interface LuService

Parameters:: cluSetId - identifier of the CLU set to be updated; cluSetInfo - updated information about the CLU set
Returns:: the updated CLU set information
Throws:: DataValidationErrorException - One or more values invalid for this operation; DoesNotExistException - cluSet not found; InvalidParameterException - invalid cluSetId, cluSetInfo; MissingParameterException - missing cluSetId, cluSetInfo; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure; VersionMismatchException - The action was attempted on an out of date version.; CircularRelationshipException - addedCluSetId cannot be added to the cluSetId; UnsupportedActionException - CLU set need to be static or dynamic but not both

deleteCluSet

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

Description copied from interface: LuService

Delete a CLU set

Specified by:: deleteCluSet in interface LuService

Parameters:: cluSetId - identifier of the CLU set to be deleted
Returns:: status of the operation (success or failure)
Throws:: DoesNotExistException - cluSet not found; InvalidParameterException - invalid cluSetId; MissingParameterException - missing cluSetId; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

addCluSetToCluSet

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

Description copied from interface: LuService

Adds one CLU set to another

Specified by:: addCluSetToCluSet in interface LuService

Parameters:: cluSetId - identifier of the host CLU set; addedCluSetId - identifier of the CLU set to be added
Returns:: status of the operation (success or failure)
Throws:: DoesNotExistException - cluSet, addedCluSet not found; InvalidParameterException - invalid cluSetId, addedCluSetId; MissingParameterException - missing cluSetId, addedCluSetId; 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)
                                  throws DoesNotExistException,
                                         InvalidParameterException,
                                         MissingParameterException,
                                         OperationFailedException,
                                         PermissionDeniedException,
                                         UnsupportedActionException

Description copied from interface: LuService

Removes one CLU set from another

Specified by:: removeCluSetFromCluSet in interface LuService

Parameters:: cluSetId - identifier of the host CLU set; removedCluSetId - identifier of the CLU set to be removed
Returns:: status of the operation (success or failure)
Throws:: DoesNotExistException - cluSet, removedCluSet not found; InvalidParameterException - invalid cluSetId, removedCluSetId; MissingParameterException - missing cluSetId, removedCluSetId; 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)
                          throws DoesNotExistException,
                                 InvalidParameterException,
                                 MissingParameterException,
                                 OperationFailedException,
                                 PermissionDeniedException,
                                 UnsupportedActionException

Description copied from interface: LuService

Add a CLU to a CLU set

Specified by:: addCluToCluSet in interface LuService

Parameters:: cluId - identifier of CLU to add to the CLU set; cluSetId - identifier of the CLU set
Returns:: status of the operation (success or failure)
Throws:: DoesNotExistException - clu, cluSet not found; InvalidParameterException - invalid cluId, cluSetId; MissingParameterException - missing cluId, cluSetId; 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)
                               throws DoesNotExistException,
                                      InvalidParameterException,
                                      MissingParameterException,
                                      OperationFailedException,
                                      PermissionDeniedException,
                                      UnsupportedActionException

Description copied from interface: LuService

Remove a CLU from a CLU set

Specified by:: removeCluFromCluSet in interface LuService

Parameters:: cluId - identifier of CLU to remove from the CLU set; cluSetId - identifier of the CLU set
Returns:: status of the operation (success or failure)
Throws:: DoesNotExistException - clu, cluSet not found; InvalidParameterException - invalid cluId, cluSetId; MissingParameterException - missing cluId, cluSetId; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure; UnsupportedActionException - CLU set is dynamically determined

validateLui

public List<ValidationResultInfo> validateLui(String validationType,
                                              LuiInfo luiInfo)
                                       throws DoesNotExistException,
                                              InvalidParameterException,
                                              MissingParameterException,
                                              OperationFailedException

Description copied from interface: LuService

Validates a LUI. 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 LUI (and/or one of its contained sub-objects) and a record is found for that identifier, the validation checks if the LUI 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:: validateLui in interface LuService

Parameters:: validationType - identifier of the extent of validation; luiInfo - LUI information to be tested.
Returns:: results from performing the validation
Throws:: DoesNotExistException - validationTypeKey not found; InvalidParameterException - invalid validationTypeKey, luiInfo; MissingParameterException - missing validationTypeKey, luiInfo; OperationFailedException - unable to complete request

createLui

@Transactional(readOnly=false)
public LuiInfo createLui(String cluId,
                                               String atpKey,
                                               LuiInfo luiInfo)
                  throws AlreadyExistsException,
                         DataValidationErrorException,
                         DoesNotExistException,
                         InvalidParameterException,
                         MissingParameterException,
                         OperationFailedException,
                         PermissionDeniedException

Description copied from interface: LuService

Creates a new LUI

Specified by:: createLui in interface LuService

Parameters:: cluId - identifier of the CLU for the LUI being created; atpKey - identifier of the academic time period for the LUI being created; luiInfo - information about the LUI being created
Returns:: the created LUI information
Throws:: AlreadyExistsException - LUI already exists; DataValidationErrorException - One or more values invalid for this operation; DoesNotExistException - clu, atp not found; InvalidParameterException - invalid cluId, atpKey, luiInfo; MissingParameterException - missing cluId, atpKey, luiInfo; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

updateLui

@Transactional(readOnly=false)
public LuiInfo updateLui(String luiId,
                                               LuiInfo luiInfo)
                  throws DataValidationErrorException,
                         DoesNotExistException,
                         InvalidParameterException,
                         MissingParameterException,
                         OperationFailedException,
                         PermissionDeniedException,
                         VersionMismatchException

Description copied from interface: LuService

Updates an existing LUI

Specified by:: updateLui in interface LuService

Parameters:: luiId - identifier for the LUI to be updated; luiInfo - updated information about the LUI
Returns:: the updated LUI information
Throws:: DataValidationErrorException - One or more values invalid for this operation; DoesNotExistException - lui not found; InvalidParameterException - invalid luiId, luiInfo; MissingParameterException - missing luiId, luiInfo; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure; VersionMismatchException - The action was attempted on an out of date version.

deleteLui

@Transactional(readOnly=false)
public StatusInfo deleteLui(String luiId)
                     throws DependentObjectsExistException,
                            DoesNotExistException,
                            InvalidParameterException,
                            MissingParameterException,
                            OperationFailedException,
                            PermissionDeniedException

Description copied from interface: LuService

Deletes a LUI record

Specified by:: deleteLui in interface LuService

Parameters:: luiId - identifier for the LUI to be deleted
Returns:: status of the operation
Throws:: DependentObjectsExistException - delete would leave orphaned objects or violate integrity constraints; DoesNotExistException - lui not found; InvalidParameterException - invalid luiId; MissingParameterException - missing luiId; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

updateLuiState

@Transactional(readOnly=false)
public LuiInfo updateLuiState(String luiId,
                                                    String luiState)
                       throws DataValidationErrorException,
                              DoesNotExistException,
                              InvalidParameterException,
                              MissingParameterException,
                              OperationFailedException,
                              PermissionDeniedException

Description copied from interface: LuService

Updates the state of the LUI

Specified by:: updateLuiState in interface LuService

Parameters:: luiId - identifier for the LUI to be updated; luiState - New state for LUI. Value is expected to be constrained to those in the luState enumeration.
Returns:: the updated LUI information
Throws:: DataValidationErrorException - New state not valid for existing state of LUI; DoesNotExistException - lui, luState not found; InvalidParameterException - invalid luiId, luState; MissingParameterException - missing luiId, luState; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

validateLuiLuiRelation

public List<ValidationResultInfo> validateLuiLuiRelation(String validationType,
                                                         LuiLuiRelationInfo luiLuiRelationInfo)
                                                  throws DoesNotExistException,
                                                         InvalidParameterException,
                                                         MissingParameterException,
                                                         OperationFailedException

Description copied from interface: LuService

Validates a relationship between LUIs. 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 relationship (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:: validateLuiLuiRelation in interface LuService

Parameters:: validationType - identifier of the extent of validation; luiLuiRelationInfo - LUI to LUI relationship information to be tested.
Returns:: results from performing the validation
Throws:: DoesNotExistException - validationTypeKey not found; InvalidParameterException - invalid validationTypeKey, luiLuiRelationInfo; MissingParameterException - missing validationTypeKey, luiLuiRelationInfo; OperationFailedException - unable to complete request

createLuiLuiRelation

@Transactional(readOnly=false)
public LuiLuiRelationInfo createLuiLuiRelation(String luiId,
                                                                     String relatedLuiId,
                                                                     String luLuRelationTypeKey,
                                                                     LuiLuiRelationInfo luiLuiRelationInfo)
                                        throws AlreadyExistsException,
                                               CircularRelationshipException,
                                               DataValidationErrorException,
                                               DoesNotExistException,
                                               InvalidParameterException,
                                               MissingParameterException,
                                               OperationFailedException,
                                               PermissionDeniedException

Description copied from interface: LuService

Create a relationship between two LUIs

Specified by:: createLuiLuiRelation in interface LuService

Parameters:: luiId - identifier of the first LUI in the relationship; relatedLuiId - identifier of the second LUI in the relationship to be related to; luLuRelationTypeKey - the LU to LU relationship type of the relationship; luiLuiRelationInfo - information about the relationship between the two LUIs
Returns:: the created LUI to LUI relation information
Throws:: AlreadyExistsException - relationship already exists; CircularRelationshipException - luiId equals relatedLuiId; DataValidationErrorException - One or more values invalid for this operation; DoesNotExistException - luiId, relatedLuiId, luLuRelationType not found; InvalidParameterException - invalid luiIds, luluRelationType, luiLuiRelationInfo; MissingParameterException - missing luiIds, luluRelationType, luiLuiRelationInfo; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

updateLuiLuiRelation

@Transactional(readOnly=false)
public LuiLuiRelationInfo updateLuiLuiRelation(String luiLuiRelationId,
                                                                     LuiLuiRelationInfo luiLuiRelationInfo)
                                        throws DataValidationErrorException,
                                               DoesNotExistException,
                                               InvalidParameterException,
                                               MissingParameterException,
                                               OperationFailedException,
                                               PermissionDeniedException,
                                               VersionMismatchException

Description copied from interface: LuService

Updates a relationship between two LUIs

Specified by:: updateLuiLuiRelation in interface LuService

Parameters:: luiLuiRelationId - identifier of the LUI to LUI relation to update; luiLuiRelationInfo - changed information about the relationship between the two LUIs
Returns:: the update LUI to LUI relation information
Throws:: DataValidationErrorException - One or more values invalid for this operation; DoesNotExistException - luiLuiRelation not found; InvalidParameterException - invalid luiLuiRelationId, luiLuiRelationInfo; MissingParameterException - missing luiLuiRelationId, luiLuiRelationInfo; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure; VersionMismatchException - The action was attempted on an out of date version.

deleteLuiLuiRelation

@Transactional(readOnly=false)
public StatusInfo deleteLuiLuiRelation(String luiLuiRelationId)
                                throws DoesNotExistException,
                                       InvalidParameterException,
                                       MissingParameterException,
                                       OperationFailedException,
                                       PermissionDeniedException

Description copied from interface: LuService

Deletes a relationship between two LUIs

Specified by:: deleteLuiLuiRelation in interface LuService

Parameters:: luiLuiRelationId - identifier of the LUI to LUI relation to delete
Returns:: status of the operation (success or failure)
Throws:: DoesNotExistException - luiLuiRelation not found; InvalidParameterException - invalid luiLuiRelationId; MissingParameterException - missing luiLuiRelationId; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

getSearchCriteriaType

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

SEARCH OPERATIONS *

Specified by:: getSearchCriteriaType in interface SearchService

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: SearchService

Retrieves the list of search criteria types known by this service.

Specified by:: getSearchCriteriaTypes in interface SearchService

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: SearchService

Retrieves information about a particular search result type. Search result types describe the return structure for a search.

Specified by:: getSearchResultType in interface SearchService

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: SearchService

Retrieves the list of search result types known by this service. Search result types describe the return structure for a search.

Specified by:: getSearchResultTypes in interface SearchService

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: SearchService

Retrieves information about a particular search type.

Specified by:: getSearchType in interface SearchService

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: SearchService

Retrieves the list of search types known by this service.

Specified by:: getSearchTypes in interface SearchService

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: SearchService

Retrieves the list of search types which use criteria in the specified format.

Specified by:: getSearchTypesByCriteria in interface SearchService

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: SearchService

Retrieves the list of search types which return results in the specified format.

Specified by:: getSearchTypesByResult in interface SearchService

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

checkCluAlreadyAdded

private void checkCluAlreadyAdded(CluSet cluSet,
                                  String cluId)
                           throws OperationFailedException

Throws:: OperationFailedException

checkCluSetAlreadyAdded

private void checkCluSetAlreadyAdded(CluSet cluSet,
                                     String cluSetIdToAdd)
                              throws OperationFailedException

Throws:: OperationFailedException

checkCluSetCircularReference

private void checkCluSetCircularReference(CluSet addedCluSet,
                                          String hostCluSetId)
                                   throws CircularRelationshipException

Throws:: CircularRelationshipException

findClusInCluSet

private void findClusInCluSet(List<String> clus,
                              CluSet parentCluSet)
                       throws DoesNotExistException

Throws:: DoesNotExistException

doFindClusInCluSet

private void doFindClusInCluSet(List<String> processedCluSetIds,
                                List<String> clus,
                                CluSet parentCluSet)

doSearchProposalsByCourseCode

private SearchResult doSearchProposalsByCourseCode(String courseCode)
                                            throws MissingParameterException

Throws:: MissingParameterException

getObjectStructure

public ObjectStructureDefinition getObjectStructure(String objectTypeKey)

Specified by:: getObjectStructure in interface DictionaryService

getObjectTypes

public List<String> getObjectTypes()

Specified by:: getObjectTypes in interface DictionaryService

getLuDao

public LuDao getLuDao()

setLuDao

public void setLuDao(LuDao luDao)

search

public SearchResult search(SearchRequest searchRequest)
                    throws MissingParameterException

Specified by:: search in interface SearchService

Throws:: MissingParameterException

doBrowseVersionsSearch

private SearchResult doBrowseVersionsSearch(SearchRequest searchRequest)
                                     throws MissingParameterException

Looks up Atp descriptions and adds to search results

Parameters:: searchRequest -
Returns:
Throws:: MissingParameterException

doBrowseProgramSearch

private SearchResult doBrowseProgramSearch()
                                    throws MissingParameterException

Throws:: MissingParameterException

doDependencyAnalysisSearch

private SearchResult doDependencyAnalysisSearch(String cluId)
                                         throws MissingParameterException,
                                                DoesNotExistException

Throws:: MissingParameterException; DoesNotExistException

checkForMissingParameter

private void checkForMissingParameter(Object param,
                                      String paramName)
                               throws MissingParameterException

Check for missing parameter and throw localized exception if missing

Parameters:: param -; parameter - name
Throws:: MissingParameterException

checkForEmptyList

private void checkForEmptyList(Object param,
                               String paramName)
                        throws MissingParameterException

Parameters:: param -; paramName -
Throws:: MissingParameterException

addCluSetsToCluSet

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

Description copied from interface: LuService

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 LuService

Parameters:: cluSetId - identifier of the host CLU set; cluSetIdList - list of identifiers of the CLU sets to be added
Returns:: status of the operation (success or failure)
Throws:: CircularRelationshipException - addedCluSetId cannot be added to the cluSetId; DoesNotExistException - cluSet, addedCluSet not found; InvalidParameterException - invalid cluSetId, addedCluSetId; MissingParameterException - missing cluSetId, addedCluSetId; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure; UnsupportedActionException - CLU set is dynamically determined

addClusToCluSet

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

Description copied from interface: LuService

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 LuService

cluSetId - identifier of the CLU set to be added
Returns:: status of the operation (success or failure)
Throws:: DoesNotExistException - clu, cluSet not found; InvalidParameterException - invalid cluId, cluSetId; MissingParameterException - missing cluId, cluSetId; 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)
                            throws DataValidationErrorException,
                                   DoesNotExistException,
                                   InvalidParameterException,
                                   MissingParameterException,
                                   OperationFailedException,
                                   PermissionDeniedException,
                                   VersionMismatchException

Versioning Methods

Specified by:: createNewCluVersion in interface LuService

Parameters:: versionIndCluId - identifier for the CLU to be versioned; versionComment - comment for the current version
Returns:: the new versioned CLU information
Throws:: DataValidationErrorException - One or more values invalid for this operation; DoesNotExistException - cluId not found; InvalidParameterException - invalid cluId; MissingParameterException - missing cluId; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure; VersionMismatchException - The action was attempted on an out of date version

clearCluIds

private void clearCluIds(CluInfo clu)

setCurrentCluVersion

@Transactional(readOnly=false)
public StatusInfo setCurrentCluVersion(String cluVersionId,
                                                             Date currentVersionStart)
                                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 client application.

Specified by:: setCurrentCluVersion in interface LuService

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
Returns:: status of the operation
Throws:: DoesNotExistException - cluVersionId not found; InvalidParameterException - invalid cluVersionId, previousState, newState; 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

getLatestVersion

public VersionDisplayInfo getLatestVersion(String refObjectTypeURI,
                                           String refObjectId)
                                    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
Returns:: current version
Throws:: DoesNotExistException - specified refObjectId, refObjectTypeURI not found; InvalidParameterException - invalid refObjectId, refObjectTypeURI; MissingParameterException - refObjectId, refObjectTypeURI not specified; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

getCurrentVersion

public VersionDisplayInfo getCurrentVersion(String refObjectTypeURI,
                                            String refObjectId)
                                     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
Returns:: current version
Throws:: DoesNotExistException - specified refObjectId, refObjectTypeURI not found; InvalidParameterException - invalid refObjectId, refObjectTypeURI; MissingParameterException - refObjectId, refObjectTypeURI not specified; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

getCurrentVersionOnDate

public VersionDisplayInfo getCurrentVersionOnDate(String refObjectTypeURI,
                                                  String refObjectId,
                                                  Date date)
                                           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
Returns:: current version on date
Throws:: DoesNotExistException - specified refObjectId, refObjectTypeURI not found; InvalidParameterException - invalid refObjectId, refObjectTypeURI, date; MissingParameterException - refObjectId, refObjectTypeURI, date not specified; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

getFirstVersion

public VersionDisplayInfo getFirstVersion(String refObjectTypeURI,
                                          String refObjectId)
                                   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
Returns:: first version
Throws:: DoesNotExistException - specified refObjectId, refObjectTypeURI not found; InvalidParameterException - invalid refObjectId, refObjectTypeURI; MissingParameterException - refObjectId, refObjectTypeURI not specified; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

getVersionBySequenceNumber

public VersionDisplayInfo getVersionBySequenceNumber(String refObjectTypeURI,
                                                     String refObjectId,
                                                     Long sequence)
                                              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
Returns:: version matching the sequence
Throws:: DoesNotExistException - specified refObjectId, refObjectTypeURI, sequence not found; InvalidParameterException - invalid refObjectId, refObjectTypeURI, sequence; MissingParameterException - refObjectId, refObjectTypeURI, sequence not specified; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

getVersions

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

Description copied from interface: VersionManagementService

Retrieves list of version associated with the objectId.

Specified by:: getVersions in interface VersionManagementService

Parameters:: refObjectTypeURI - reference object type URI; refObjectId - reference object Id
Returns:: list of versions
Throws:: DoesNotExistException - specified refObjectId, refObjectTypeURI not found; InvalidParameterException - invalid refObjectId, refObjectTypeURI; MissingParameterException - refObjectId, refObjectTypeURI not specified; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

getVersionsInDateRange

public List<VersionDisplayInfo> getVersionsInDateRange(String refObjectTypeURI,
                                                       String refObjectId,
                                                       Date from,
                                                       Date to)
                                                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:: getVersionsInDateRange in interface VersionManagementService

Parameters:: refObjectTypeURI - reference object type URI; refObjectId - reference object Id; from - from date; to - to date
Returns:: current version on date
Throws:: DoesNotExistException - specified refObjectId, refObjectTypeURI not found; InvalidParameterException - invalid refObjectId, refObjectTypeURI, date; MissingParameterException - refObjectId, refObjectTypeURI, date not specified; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

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.lum.lu.service.impl Class LuServiceImpl

SEARCH_KEY_DEPENDENCY_ANALYSIS

SEARCH_KEY_BROWSE_PROGRAM

SEARCH_KEY_BROWSE_VARIATIONS

SEARCH_KEY_RESULT_COMPONENT

SEARCH_KEY_PROPOSALS_BY_COURSE_CODE

SEARCH_KEY_BROWSE_VERSIONS

logger

luDao

searchManager

searchDispatcher

dictionaryServiceDelegate

validatorFactory

LuServiceImpl

setSearchManager

setDictionaryServiceDelegate

getDictionaryServiceDelegate

getDeliveryMethodTypes

getDeliveryMethodType

getInstructionalFormatTypes

getInstructionalFormatType

getLuTypes

getLuType

getLuCodeType

getLuCodeTypes

getLuLuRelationTypes

getLuLuRelationType

getAllowedLuLuRelationTypesForLuType

getLuPublicationTypes

getLuPublicationType

getLuPublicationTypesForLuType

getCluResultTypes

getCluResultType

getCluResultTypesForLuType

getResultUsageTypes

getResultUsageType

getAllowedResultUsageTypesForLuType

getAllowedResultComponentTypesForResultUsageType

getCluLoRelationType

getCluLoRelationTypes

getAllowedCluLoRelationTypesForLuType

getCluSetTypes

getCluSetType

getClu

getClusByIdList

getClusByLuType

getCluIdsByLuType

getAllowedLuLuRelationTypesByCluId

getClusByRelation

getCluIdsByRelation

getRelatedClusByCluId

getRelatedCluIdsByCluId

getCluCluRelation

getCluCluRelationsByClu

getCluPublicationsByCluId

getCluPublicationsByType

getCluPublication

getCluResult

getCluResultByClu

getCluIdsByResultUsageType

getCluIdsByResultComponent

getCluLoRelation

getCluLoRelationsByClu

getCluLoRelationsByLo

getResourceRequirementsForCluId

getCluSetInfo

getCluSetTreeView

getCluSetTreeViewHelper

getCluSetInfoByIdList

getCluSetIdsFromCluSet

isCluSetDynamic

getClusFromCluSet

getCluIdsFromCluSet

getAllClusInCluSet

getAllCluIdsInCluSet

isCluInCluSet

getLui

getLuisByIdList

getLuisInAtpByCluId

getLuiIdsByCluId

org.kuali.student.lum.lu.service.impl
Class LuServiceImpl