LuService (Kuali Student 1.3.0-services-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.r1.lum.lu.service
Interface LuService

All Superinterfaces:: DictionaryService, SearchService, VersionManagementService

public interface LuService
extends DictionaryService, SearchService, VersionManagementService
extends DictionaryService, SearchService, VersionManagementService

Method Summary
`StatusInfo`	`addCluResourceRequirement(String resourceTypeKey, String cluId)` Add a Resource requirement to a CLU
`StatusInfo`	`addCluSetsToCluSet(String cluSetId, List<String> addedCluSetIdList)` 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
`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 cluResultType, 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 luLuRelationType, LuiLuiRelationInfo luiLuiRelationInfo)` Create a relationship between two LUIs
`CluInfo`	`createNewCluVersion(String cluId, String versionComment)` Creates a new CLU version based on the current clu
`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
`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)` Retrieves core information about a CLU
`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 luLuRelationType)` 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 luLuRelationType)` 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.
`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.
`DeliveryMethodTypeInfo`	`getDeliveryMethodType(String deliveryMethodTypeKey)` Retrieves information about a delivery method type
`List<DeliveryMethodTypeInfo>`	`getDeliveryMethodTypes()` Retrieves the list of delivery method types
`InstructionalFormatTypeInfo`	`getInstructionalFormatType(String instructionalFormatTypeKey)` Retrieves information about a Instructional Format Type
`List<InstructionalFormatTypeInfo>`	`getInstructionalFormatTypes()` Retrieves the list of instructional format types
`LuCodeTypeInfo`	`getLuCodeType(String luCodeTypeKey)` Retrieves information about a learning unit code type
`List<LuCodeTypeInfo>`	`getLuCodeTypes()` Retrieves the list of learning unit code types
`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 relatedLuiId, String luLuRelationType)` 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 relatedLuiId, String luLuRelationType)` 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
`List<String>`	`getRelatedCluIdsByCluId(String cluId, String luLuRelationType)` 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 luLuRelationType)` 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 luLuRelationType)` Retrieves the list of related LUI Ids for the specified LUI Id and LU to LU relation type.
`List<LuiInfo>`	`getRelatedLuisByLuiId(String luiId, String luLuRelationType)` 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
`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
`StatusInfo`	`setCurrentCluVersion(String cluVersionId, Date currentVersionStart)` Sets a specific version of the Clu as current.
`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 luState)` Updates the state of the LUI
`List<ValidationResultInfo>`	`validateClu(String validationType, CluInfo cluInfo)` Validates a CLU.
`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.
`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 interface org.kuali.student.r1.common.dictionary.service.DictionaryService
`getObjectStructure, getObjectTypes`

Methods inherited from interface org.kuali.student.r1.common.search.service.SearchService
`getSearchCriteriaType, getSearchCriteriaTypes, getSearchResultType, getSearchResultTypes, getSearchType, getSearchTypes, getSearchTypesByCriteria, getSearchTypesByResult, search`

Methods inherited from interface org.kuali.student.r2.core.versionmanagement.service.VersionManagementService
`getCurrentVersion, getCurrentVersionOnDate, getFirstVersion, getLatestVersion, getVersionBySequenceNumber, getVersions, getVersionsInDateRange`

Method Detail

getDeliveryMethodTypes

List<DeliveryMethodTypeInfo> getDeliveryMethodTypes()
                                                    throws OperationFailedException

Retrieves the list of delivery method types

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

getDeliveryMethodType

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

Retrieves information about a delivery method type

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

List<InstructionalFormatTypeInfo> getInstructionalFormatTypes()
                                                              throws OperationFailedException

Retrieves the list of instructional format types

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

getInstructionalFormatType

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

Retrieves information about a Instructional Format Type

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

List<LuTypeInfo> getLuTypes()
                            throws OperationFailedException

Retrieves the list of LU types

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

getLuType

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

Retrieves information about a LU Type

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

getLuCodeTypes

List<LuCodeTypeInfo> getLuCodeTypes()
                                    throws OperationFailedException

Retrieves the list of learning unit code types

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

getLuCodeType

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

Retrieves information about a learning unit code type

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

getLuLuRelationTypes

List<LuLuRelationTypeInfo> getLuLuRelationTypes()
                                                throws OperationFailedException

Retrieves the complete list of LU to LU relation types

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

getLuLuRelationType

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

Retrieves the LU to LU relation type

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

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

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

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

List<LuPublicationTypeInfo> getLuPublicationTypes()
                                                  throws OperationFailedException

Retrieves the list of Learning Unit publication types

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

getLuPublicationType

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

Retrieves information about a publication type

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

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

Retrieves information about a publication type

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

List<CluResultTypeInfo> getCluResultTypes()
                                          throws OperationFailedException

Retrieves a list of types for clu result objects.

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

getCluResultType

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

Retrieves information about a publication type

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

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

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

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

List<ResultUsageTypeInfo> getResultUsageTypes()
                                              throws OperationFailedException

Retrieves a list of result usage types

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

getResultUsageType

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

Retrieves information about a Result Usage Type

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

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

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

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

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

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

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

getCluLoRelationTypes

List<CluLoRelationTypeInfo> getCluLoRelationTypes()
                                                  throws OperationFailedException

Retrieves the complete list of CLU to LO relation types

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

getCluLoRelationType

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

Retrieves information for a specified CLU to LO relation type

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

getAllowedCluLoRelationTypesForLuType

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

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

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

List<CluSetTypeInfo> getCluSetTypes()
                                    throws OperationFailedException

Retrieves the list of CLU set types known by the service

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

getCluSetType

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

Retrieves information about a specified CLU set type

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

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

Retrieves core information about a CLU

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

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

Retrieves information about CLUs from a list of ids

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

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

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

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

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

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

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

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

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

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

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

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)

Parameters:: relatedCluId - identifier of the child or To CLU; luLuRelationType - 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

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

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

Parameters:: relatedCluId - identifier of the child or To CLU; luLuRelationType - 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

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

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

Parameters:: cluId - identifier of the parent or From CLU; luLuRelationType - 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

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

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

Parameters:: cluId - identifier of the parent or From CLU; luLuRelationType - 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

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

Retrieves the relationship information between CLUs for a particular Relation instance

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

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

Retrieves the list of relationship information for the specified CLU

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

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

Retrieves a list of publication objects for a particular clu

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

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

Retrieves a list of publication objects of a particular Type

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

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

Retrieves an LU publication object by its identifier

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

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

Retrieves information about a Clu Result

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

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

Retrieves the cluResult for a particular clu

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

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

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

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

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

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

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

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

Retrieve information on a CLU LO Relation.

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

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

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

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

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

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

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

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

Retrieves the list of Resource requirements for the specified CLU

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

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

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

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

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

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

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

getCluSetInfoByIdList

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

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

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

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

Retrieve the list of CLU Set Ids within a CLU Set

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

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

Check if the given CluSet is dynamic

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Retrieves information about a LUI

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

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

Retrieves information about LUIs from a list of Ids

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

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

Retrieves the list of LUIs for the specified CLU and period

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

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

Retrieves the list of LUI ids for the specified CLU

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

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

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

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

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

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

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

List<LuiInfo> getLuisByRelation(String relatedLuiId,
                                String luLuRelationType)
                                throws DoesNotExistException,
                                       InvalidParameterException,
                                       MissingParameterException,
                                       OperationFailedException

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)

Parameters:: relatedLuiId - identifier of the LUI; luLuRelationType - 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

List<String> getLuiIdsByRelation(String relatedLuiId,
                                 String luLuRelationType)
                                 throws DoesNotExistException,
                                        InvalidParameterException,
                                        MissingParameterException,
                                        OperationFailedException

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

Parameters:: relatedLuiId - identifier of the LUI; luLuRelationType - 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

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

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

Parameters:: luiId - identifier of the LUI; luLuRelationType - 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

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

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

Parameters:: luiId - identifier of the LUI; luLuRelationType - 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

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

Retrieves the relationship information between LUIs given a specific relation instance

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

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

Retrieves the list of relationship information for the specified LUI

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

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

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

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

CluInfo createClu(String luTypeKey,
                  CluInfo cluInfo)
                  throws AlreadyExistsException,
                         DataValidationErrorException,
                         DoesNotExistException,
                         InvalidParameterException,
                         MissingParameterException,
                         OperationFailedException,
                         PermissionDeniedException

Creates a new CLU

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

updateClu

CluInfo updateClu(String cluId,
                  CluInfo cluInfo)
                  throws DataValidationErrorException,
                         DoesNotExistException,
                         InvalidParameterException,
                         MissingParameterException,
                         OperationFailedException,
                         PermissionDeniedException,
                         VersionMismatchException

Updates an existing CLU

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

StatusInfo deleteClu(String cluId)
                     throws DoesNotExistException,
                            InvalidParameterException,
                            MissingParameterException,
                            DependentObjectsExistException,
                            OperationFailedException,
                            PermissionDeniedException

Deletes an existing CLU

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

createNewCluVersion

CluInfo createNewCluVersion(String cluId,
                            String versionComment)
                            throws DataValidationErrorException,
                                   DoesNotExistException,
                                   InvalidParameterException,
                                   MissingParameterException,
                                   OperationFailedException,
                                   PermissionDeniedException,
                                   VersionMismatchException

Creates a new CLU version based on the current clu

Parameters:: cluId - 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

setCurrentCluVersion

StatusInfo setCurrentCluVersion(String cluVersionId,
                                Date currentVersionStart)
                                throws DoesNotExistException,
                                       InvalidParameterException,
                                       MissingParameterException,
                                       IllegalVersionSequencingException,
                                       OperationFailedException,
                                       PermissionDeniedException

Sets a specific version of the Clu as current. The sequence number must be greater than the existing current Clu version. This will truncate the current version's end date to the currentVersionStart param. If a Clu exists which is set to become current in the future, that clu's currentVersionStart and CurrentVersionEnd will be nullified. The currentVersionStart must be in the future to prevent changing historic data.

Parameters:: cluVersionId - Version Specific Id of the Clu; currentVersionStart - Date when this clu becomes current. Must be in the future and be after the most current clu's start date.
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

updateCluState

CluInfo updateCluState(String cluId,
                       String luState)
                       throws DataValidationErrorException,
                              DoesNotExistException,
                              InvalidParameterException,
                              MissingParameterException,
                              OperationFailedException,
                              PermissionDeniedException

Updates the state of the specified CLU

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

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

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

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

CluCluRelationInfo createCluCluRelation(String cluId,
                                        String relatedCluId,
                                        String luLuRelationTypeKey,
                                        CluCluRelationInfo cluCluRelationInfo)
                                        throws AlreadyExistsException,
                                               CircularRelationshipException,
                                               DataValidationErrorException,
                                               DoesNotExistException,
                                               InvalidParameterException,
                                               MissingParameterException,
                                               OperationFailedException,
                                               PermissionDeniedException

Create a directional relationship between two CLUs

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; CircularRelationshipException - cluId equals relatedCluId; 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

updateCluCluRelation

CluCluRelationInfo updateCluCluRelation(String cluCluRelationId,
                                        CluCluRelationInfo cluCluRelationInfo)
                                        throws DataValidationErrorException,
                                               DoesNotExistException,
                                               InvalidParameterException,
                                               MissingParameterException,
                                               OperationFailedException,
                                               PermissionDeniedException,
                                               VersionMismatchException

Updates a relationship between two CLUs

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

StatusInfo deleteCluCluRelation(String cluCluRelationId)
                                throws DoesNotExistException,
                                       InvalidParameterException,
                                       MissingParameterException,
                                       OperationFailedException,
                                       PermissionDeniedException

Deletes a relationship between two CLUs

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

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

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.

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

CluPublicationInfo createCluPublication(String cluId,
                                        String luPublicationType,
                                        CluPublicationInfo cluPublicationInfo)
                                        throws AlreadyExistsException,
                                               DataValidationErrorException,
                                               InvalidParameterException,
                                               MissingParameterException,
                                               OperationFailedException,
                                               PermissionDeniedException

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

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

CluPublicationInfo updateCluPublication(String cluPublicationId,
                                        CluPublicationInfo cluPublicationInfo)
                                        throws DataValidationErrorException,
                                               DoesNotExistException,
                                               InvalidParameterException,
                                               MissingParameterException,
                                               OperationFailedException,
                                               PermissionDeniedException,
                                               VersionMismatchException

Updates an existing clu publication object

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

StatusInfo deleteCluPublication(String cluPublicationId)
                                throws DoesNotExistException,
                                       InvalidParameterException,
                                       MissingParameterException,
                                       DependentObjectsExistException,
                                       OperationFailedException,
                                       PermissionDeniedException

Deletes an existing clu publication object

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

List<ValidationResultInfo> validateCluResult(String validationType,
                                             CluResultInfo cluResultInfo)
                                             throws DoesNotExistException,
                                                    InvalidParameterException,
                                                    MissingParameterException,
                                                    OperationFailedException

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.

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

CluResultInfo createCluResult(String cluId,
                              String cluResultType,
                              CluResultInfo cluResultInfo)
                              throws AlreadyExistsException,
                                     DataValidationErrorException,
                                     InvalidParameterException,
                                     MissingParameterException,
                                     OperationFailedException,
                                     PermissionDeniedException,
                                     DoesNotExistException

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

Parameters:: cluId - identifier of a clu; cluResultType - 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

CluResultInfo updateCluResult(String cluResultId,
                              CluResultInfo cluResultInfo)
                              throws DataValidationErrorException,
                                     DoesNotExistException,
                                     InvalidParameterException,
                                     MissingParameterException,
                                     OperationFailedException,
                                     PermissionDeniedException,
                                     VersionMismatchException

Updates an existing clu result

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

StatusInfo deleteCluResult(String cluResultId)
                           throws DoesNotExistException,
                                  InvalidParameterException,
                                  MissingParameterException,
                                  DependentObjectsExistException,
                                  OperationFailedException,
                                  PermissionDeniedException

Deletes an existing clu result

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

List<ValidationResultInfo> validateCluLoRelation(String validationType,
                                                 CluLoRelationInfo cluLoRelationInfo)
                                                 throws DoesNotExistException,
                                                        InvalidParameterException,
                                                        MissingParameterException,
                                                        OperationFailedException

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.

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

CluLoRelationInfo createCluLoRelation(String cluId,
                                      String loId,
                                      String cluLoRelationType,
                                      CluLoRelationInfo cluLoRelationInfo)
                                      throws AlreadyExistsException,
                                             DoesNotExistException,
                                             InvalidParameterException,
                                             MissingParameterException,
                                             OperationFailedException,
                                             PermissionDeniedException,
                                             DataValidationErrorException

Creates a relationship between a learning objective and a CLU.

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

CluLoRelationInfo updateCluLoRelation(String cluLoRelationId,
                                      CluLoRelationInfo cluLoRelationInfo)
                                      throws DataValidationErrorException,
                                             DoesNotExistException,
                                             InvalidParameterException,
                                             MissingParameterException,
                                             OperationFailedException,
                                             PermissionDeniedException,
                                             VersionMismatchException

Updates a relationship between a clu and learning objective

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

StatusInfo deleteCluLoRelation(String cluLoRelationId)
                               throws DoesNotExistException,
                                      InvalidParameterException,
                                      MissingParameterException,
                                      OperationFailedException,
                                      PermissionDeniedException

Removes a relationship between a learning objective and a Clu.

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

StatusInfo addCluResourceRequirement(String resourceTypeKey,
                                     String cluId)
                                     throws AlreadyExistsException,
                                            DoesNotExistException,
                                            InvalidParameterException,
                                            MissingParameterException,
                                            OperationFailedException,
                                            PermissionDeniedException

Add a Resource requirement to a CLU

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

StatusInfo removeCluResourceRequirement(String resourceTypeKey,
                                        String cluId)
                                        throws DoesNotExistException,
                                               InvalidParameterException,
                                               MissingParameterException,
                                               OperationFailedException,
                                               PermissionDeniedException

Remove a Resource requirement from a CLU

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

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

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.

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

CluSetInfo createCluSet(String cluSetType,
                        CluSetInfo cluSetInfo)
                        throws AlreadyExistsException,
                               DataValidationErrorException,
                               InvalidParameterException,
                               MissingParameterException,
                               OperationFailedException,
                               PermissionDeniedException,
                               UnsupportedActionException

Creates a CLU set.

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

updateCluSet

CluSetInfo updateCluSet(String cluSetId,
                        CluSetInfo cluSetInfo)
                        throws DataValidationErrorException,
                               DoesNotExistException,
                               InvalidParameterException,
                               MissingParameterException,
                               OperationFailedException,
                               PermissionDeniedException,
                               VersionMismatchException,
                               UnsupportedActionException,
                               CircularRelationshipException

Update the information for a CLU set

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.; UnsupportedActionException - CLU set need to be static or dynamic but not both; CircularRelationshipException - addedCluSetId cannot be added to the cluSetId

deleteCluSet

StatusInfo deleteCluSet(String cluSetId)
                        throws DoesNotExistException,
                               InvalidParameterException,
                               MissingParameterException,
                               OperationFailedException,
                               PermissionDeniedException

Delete a CLU set

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

StatusInfo addCluSetToCluSet(String cluSetId,
                             String addedCluSetId)
                             throws CircularRelationshipException,
                                    DoesNotExistException,
                                    InvalidParameterException,
                                    MissingParameterException,
                                    OperationFailedException,
                                    PermissionDeniedException,
                                    UnsupportedActionException

Adds one CLU set to another

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

addCluSetsToCluSet

StatusInfo addCluSetsToCluSet(String cluSetId,
                              List<String> addedCluSetIdList)
                              throws CircularRelationshipException,
                                     DoesNotExistException,
                                     InvalidParameterException,
                                     MissingParameterException,
                                     OperationFailedException,
                                     PermissionDeniedException,
                                     UnsupportedActionException

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

Parameters:: cluSetId - identifier of the host CLU set; addedCluSetIdList - 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

removeCluSetFromCluSet

StatusInfo removeCluSetFromCluSet(String cluSetId,
                                  String removedCluSetId)
                                  throws DoesNotExistException,
                                         InvalidParameterException,
                                         MissingParameterException,
                                         OperationFailedException,
                                         PermissionDeniedException,
                                         UnsupportedActionException

Removes one CLU set from another

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

StatusInfo addCluToCluSet(String cluId,
                          String cluSetId)
                          throws DoesNotExistException,
                                 InvalidParameterException,
                                 MissingParameterException,
                                 OperationFailedException,
                                 PermissionDeniedException,
                                 UnsupportedActionException

Add a CLU to a CLU set

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

addClusToCluSet

StatusInfo addClusToCluSet(List<String> cluIdList,
                           String cluSetId)
                           throws DoesNotExistException,
                                  InvalidParameterException,
                                  MissingParameterException,
                                  OperationFailedException,
                                  PermissionDeniedException,
                                  UnsupportedActionException

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

Parameters:: cluSetIds - list of identifiers of CLUs to add to the CLU set; 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

removeCluFromCluSet

StatusInfo removeCluFromCluSet(String cluId,
                               String cluSetId)
                               throws DoesNotExistException,
                                      InvalidParameterException,
                                      MissingParameterException,
                                      OperationFailedException,
                                      PermissionDeniedException,
                                      UnsupportedActionException

Remove a CLU from a CLU set

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

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

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.

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

LuiInfo createLui(String cluId,
                  String atpKey,
                  LuiInfo luiInfo)
                  throws AlreadyExistsException,
                         DataValidationErrorException,
                         DoesNotExistException,
                         InvalidParameterException,
                         MissingParameterException,
                         OperationFailedException,
                         PermissionDeniedException

Creates a new LUI

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

LuiInfo updateLui(String luiId,
                  LuiInfo luiInfo)
                  throws DataValidationErrorException,
                         DoesNotExistException,
                         InvalidParameterException,
                         MissingParameterException,
                         OperationFailedException,
                         PermissionDeniedException,
                         VersionMismatchException

Updates an existing LUI

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

StatusInfo deleteLui(String luiId)
                     throws DependentObjectsExistException,
                            DoesNotExistException,
                            InvalidParameterException,
                            MissingParameterException,
                            OperationFailedException,
                            PermissionDeniedException

Deletes a LUI record

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

LuiInfo updateLuiState(String luiId,
                       String luState)
                       throws DataValidationErrorException,
                              DoesNotExistException,
                              InvalidParameterException,
                              MissingParameterException,
                              OperationFailedException,
                              PermissionDeniedException

Updates the state of the LUI

Parameters:: luiId - identifier for the LUI to be updated; luState - 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

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

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.

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

LuiLuiRelationInfo createLuiLuiRelation(String luiId,
                                        String relatedLuiId,
                                        String luLuRelationType,
                                        LuiLuiRelationInfo luiLuiRelationInfo)
                                        throws AlreadyExistsException,
                                               CircularRelationshipException,
                                               DataValidationErrorException,
                                               DoesNotExistException,
                                               InvalidParameterException,
                                               MissingParameterException,
                                               OperationFailedException,
                                               PermissionDeniedException

Create a relationship between two LUIs

Parameters:: luiId - identifier of the first LUI in the relationship; relatedLuiId - identifier of the second LUI in the relationship to be related to; luLuRelationType - 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

LuiLuiRelationInfo updateLuiLuiRelation(String luiLuiRelationId,
                                        LuiLuiRelationInfo luiLuiRelationInfo)
                                        throws DataValidationErrorException,
                                               DoesNotExistException,
                                               InvalidParameterException,
                                               MissingParameterException,
                                               OperationFailedException,
                                               PermissionDeniedException,
                                               VersionMismatchException

Updates a relationship between two LUIs

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

StatusInfo deleteLuiLuiRelation(String luiLuiRelationId)
                                throws DoesNotExistException,
                                       InvalidParameterException,
                                       MissingParameterException,
                                       OperationFailedException,
                                       PermissionDeniedException

Deletes a relationship between two LUIs

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

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.r1.lum.lu.service Interface LuService

getDeliveryMethodTypes

getDeliveryMethodType

getInstructionalFormatTypes

getInstructionalFormatType

getLuTypes

getLuType

getLuCodeTypes

getLuCodeType

getLuLuRelationTypes

getLuLuRelationType

getAllowedLuLuRelationTypesForLuType

getLuPublicationTypes

getLuPublicationType

getLuPublicationTypesForLuType

getCluResultTypes

getCluResultType

getCluResultTypesForLuType

getResultUsageTypes

getResultUsageType

getAllowedResultUsageTypesForLuType

getAllowedResultComponentTypesForResultUsageType

getCluLoRelationTypes

getCluLoRelationType

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

getCluSetInfoByIdList

getCluSetIdsFromCluSet

isCluSetDynamic

getClusFromCluSet

getCluIdsFromCluSet

getAllClusInCluSet

getAllCluIdsInCluSet

isCluInCluSet

getLui

getLuisByIdList

getLuisInAtpByCluId

getLuiIdsByCluId

getLuiIdsInAtpByCluId

getAllowedLuLuRelationTypesByLuiId

getLuisByRelation

getLuiIdsByRelation

getRelatedLuisByLuiId

getRelatedLuiIdsByLuiId

getLuiLuiRelation

getLuiLuiRelationsByLui

validateClu

createClu

updateClu

deleteClu

createNewCluVersion

setCurrentCluVersion

updateCluState

validateCluCluRelation

createCluCluRelation

org.kuali.student.r1.lum.lu.service
Interface LuService