org.kuali.student.lum.lo.service
Interface LearningObjectiveService

All Superinterfaces:

DictionaryService, SearchService

All Known Implementing Classes:

LearningObjectiveServiceImpl

public interface LearningObjectiveService
extends DictionaryService, SearchService

Method Summary

StatusInfo	addLoCategoryToLo(String loCategoryId, String loId) Add a existing learning objective category to an existing learning objective in the same repository.
LoInfo	createLo(String loRepositoryKey, String loType, LoInfo loInfo) Create a learning objective.
LoCategoryInfo	createLoCategory(String loRepositoryKey, String loCategoryTypeKey, LoCategoryInfo loCategoryInfo) Create a learning objective category in a particular learning objective repository.
LoLoRelationInfo	createLoLoRelation(String loId, String relatedLoId, String loLoRelationType, LoLoRelationInfo loLoRelationInfo) Create a directional relationship between two LOs
StatusInfo	deleteLo(String loId) Delete a learning objective.
StatusInfo	deleteLoCategory(String loCategoryId) Deletes a learning objective category.
StatusInfo	deleteLoLoRelation(String loLoRelationId) Deletes a relationship between two LOs
List<String>	getAllowedLoLoRelationTypesForLoType(String loTypeKey, String relatedLoTypeKey) Retrieves the list of allowed relation types between the two specified LO Types
LoInfo	getLo(String loId) Retrieves information on a single learning objective.
List<LoInfo>	getLoByIdList(List<String> loId) Retrieves information on multiple learning objectives.
List<LoCategoryInfo>	getLoCategories(String loRepositoryKey) Retrieves information about all the learning objective categories in a given learning objective repository.
List<LoCategoryInfo>	getLoCategoriesForLo(String loId) Retrieves a list of learning objective categories for a specific learning objective.
LoCategoryInfo	getLoCategory(String loCategoryId) Retrieves information about an learning objective category.
LoCategoryTypeInfo	getLoCategoryType(String loCategoryTypeKey) Retrieves information about a particular learning objective category type.
List<LoCategoryTypeInfo>	getLoCategoryTypes() Retrieves the list of learning objective category types known by this service.
LoLoRelationInfo	getLoLoRelation(String loLoRelationId) Retrieves the relationship information between LOs for a particular relationship identifier
List<LoLoRelationInfo>	getLoLoRelationsByLoId(String loId) Retrieves the relationship information between LOs for a particular LO.
LoLoRelationTypeInfo	getLoLoRelationType(String loLoRelationTypeKey) Retrieves the LO to LO relation type
List<LoLoRelationTypeInfo>	getLoLoRelationTypes() Retrieves the complete list of LO to LO relation types
List<LoRepositoryInfo>	getLoRepositories() Retrieves the list of learning objective repositories known by this service.
LoRepositoryInfo	getLoRepository(String loRepositoryKey) Retrieves information about a particular learning objective repository.
List<LoInfo>	getLosByLoCategory(String loCategoryId) Retrieves a list of learning objectives that have a specific learning objective category.
List<LoInfo>	getLosByRelatedLoId(String relatedLoId, String loLoRelationType) Retrieves the list of LO information for the LOs related to a specified LO Id with a certain LU to LU relation type (getRelatedLosByLoId from the other direction)
List<LoInfo>	getLosByRepository(String loRepositoryKey, String loTypeKey, String loStateKey) Retrieves learning objectives from a given repository of a given type and state.
LoTypeInfo	getLoType(String loTypeKey) Retrieves information about a particular learning objective type.
List<LoTypeInfo>	getLoTypes() Retrieves the list of learning objective types known by this service.
List<LoInfo>	getRelatedLosByLoId(String loId, String loLoRelationType) Retrieves the list of related LO information for the specified LO Id and LU to LU relation type (getLosByRelatedLoId from the other direction)
StatusInfo	removeLoCategoryFromLo(String loCategoryId, String loId) Remove a existing learning objective category from an existing learning objective in the same repository.
LoInfo	updateLo(String loId, LoInfo loInfo) Update a learning objective.
LoCategoryInfo	updateLoCategory(String loCategoryId, LoCategoryInfo loCategoryInfo) Updates a learning objective category in a particular learning objective repository.
LoLoRelationInfo	updateLoLoRelation(String loLoRelationId, LoLoRelationInfo loLoRelationInfo) Updates a relationship between two LOs
List<ValidationResultInfo>	validateLo(String validationType, LoInfo loInfo) Validates a learning objective.
List<ValidationResultInfo>	validateLoCategory(String validationType, LoCategoryInfo loCategoryInfo) Validates a learning objective category.
List<ValidationResultInfo>	validateLoLoRelation(String validationType, LoLoRelationInfo loLoRelationInfo) Validates a loLoRelation.

Methods inherited from interface org.kuali.student.core.dictionary.service.DictionaryService

getObjectStructure, getObjectTypes

Methods inherited from interface org.kuali.student.core.search.service.SearchService

getSearchCriteriaType, getSearchCriteriaTypes, getSearchResultType, getSearchResultTypes, getSearchType, getSearchTypes, getSearchTypesByCriteria, getSearchTypesByResult, search

Method Detail

getLoRepositories

List<LoRepositoryInfo> getLoRepositories()
                                         throws OperationFailedException

Retrieves the list of learning objective repositories known by this service.

Returns:

list of learning objective repository information

Throws:

OperationFailedException - unable to complete request

getLoRepository

LoRepositoryInfo getLoRepository(String loRepositoryKey)
                                 throws DoesNotExistException,
                                        InvalidParameterException,
                                        MissingParameterException,
                                        OperationFailedException

Retrieves information about a particular learning objective repository.

Parameters:

loRepositoryKey - learning objective repository identifier

Returns:

information about a learning objective repository

Throws:

DoesNotExistException - specified learning objective repository not found

InvalidParameterException - invalid loRepositoryKey

MissingParameterException - loRepositoryKey not specified

OperationFailedException - unable to complete request

getLoCategoryTypes

List<LoCategoryTypeInfo> getLoCategoryTypes()
                                            throws OperationFailedException

Retrieves the list of learning objective category types known by this service.

Returns:

list of learning objective category type information

Throws:

OperationFailedException - unable to complete request

getLoCategoryType

LoCategoryTypeInfo getLoCategoryType(String loCategoryTypeKey)
                                     throws DoesNotExistException,
                                            InvalidParameterException,
                                            MissingParameterException,
                                            OperationFailedException

Retrieves information about a particular learning objective category type.

Parameters:

loCategoryTypeKey - learning objective category type identifier

Returns:

information about a learning objective category type

Throws:

DoesNotExistException - specified learning objective category type not found

InvalidParameterException - invalid loCategoryTypeKey

MissingParameterException - loCategoryTypeKey not specified

OperationFailedException - unable to complete request

getLoTypes

List<LoTypeInfo> getLoTypes()
                            throws OperationFailedException

Retrieves the list of learning objective types known by this service.

Returns:

list of learning objective type information

Throws:

OperationFailedException - unable to complete request

getLoType

LoTypeInfo getLoType(String loTypeKey)
                     throws DoesNotExistException,
                            InvalidParameterException,
                            MissingParameterException,
                            OperationFailedException

Retrieves information about a particular learning objective type.

Parameters:

loTypeKey - learning objective type identifier

Returns:

information about a learning objective type

Throws:

DoesNotExistException - specified learning objective type not found

InvalidParameterException - invalid loTypeKey

MissingParameterException - loTypeKey not specified

OperationFailedException - unable to complete request

getLoLoRelationTypes

List<LoLoRelationTypeInfo> getLoLoRelationTypes()
                                                throws OperationFailedException

Retrieves the complete list of LO to LO relation types

Returns:

list of LO to LO relation type information

Throws:

OperationFailedException - unable to complete request

getLoLoRelationType

LoLoRelationTypeInfo getLoLoRelationType(String loLoRelationTypeKey)
                                         throws OperationFailedException,
                                                MissingParameterException,
                                                DoesNotExistException

Retrieves the LO to LO relation type

Parameters:

loLoRelationTypeKey - Key of the LO to LO Relation Type

Returns:

LO to LO relation type information

Throws:

OperationFailedException - unable to complete request

MissingParameterException

DoesNotExistException

getAllowedLoLoRelationTypesForLoType

List<String> getAllowedLoLoRelationTypesForLoType(String loTypeKey,
                                                  String relatedLoTypeKey)
                                                  throws DoesNotExistException,
                                                         InvalidParameterException,
                                                         MissingParameterException,
                                                         OperationFailedException

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

Parameters:

loTypeKey - Key of the first LO Type

relatedLoTypeKey - Key of the second LO Type

Returns:

list of LO to LO relation types

Throws:

DoesNotExistException - loTypeKey, relatedLoTypeKey not found

InvalidParameterException - invalid loTypeKey, relatedLoTypeKey

MissingParameterException - missing loTypeKey, relatedLoTypeKey

OperationFailedException - unable to complete request

getLoCategories

List<LoCategoryInfo> getLoCategories(String loRepositoryKey)
                                     throws DoesNotExistException,
                                            InvalidParameterException,
                                            MissingParameterException,
                                            OperationFailedException

Retrieves information about all the learning objective categories in a given learning objective repository.

Parameters:

loRepositoryKey - loRepository identifier

Returns:

list of learning objective category information

Throws:

DoesNotExistException - loRepositoryKey not found

InvalidParameterException - invalid loRepositoryKey

MissingParameterException - missing loRepositoryKey

OperationFailedException - unable to complete request

getLoCategory

LoCategoryInfo getLoCategory(String loCategoryId)
                             throws DoesNotExistException,
                                    InvalidParameterException,
                                    MissingParameterException,
                                    OperationFailedException

Retrieves information about an learning objective category.

Parameters:

loCategoryId - loCategory identifier

Returns:

LoCategory

Throws:

DoesNotExistException - loCategoryId not found

InvalidParameterException - invalid loCategoryId

MissingParameterException - missing loCategoryId

OperationFailedException - unable to complete request

getLo

LoInfo getLo(String loId)
             throws DoesNotExistException,
                    InvalidParameterException,
                    MissingParameterException,
                    OperationFailedException

Retrieves information on a single learning objective.

Parameters:

loId - learning objective identifier

Returns:

information about a single learning objective

Throws:

DoesNotExistException - loId not found

InvalidParameterException - invalid loId

MissingParameterException - missing loId

OperationFailedException - unable to complete request

getLoByIdList

List<LoInfo> getLoByIdList(List<String> loId)
                           throws InvalidParameterException,
                                  MissingParameterException,
                                  OperationFailedException

Retrieves information on multiple learning objectives.

Parameters:

loId - list of learning objective identifiers

Returns:

list of learning objective information

Throws:

InvalidParameterException - invalid loIdList

MissingParameterException - missing loIdList

OperationFailedException - unable to complete request

getLosByRepository

List<LoInfo> getLosByRepository(String loRepositoryKey,
                                String loTypeKey,
                                String loStateKey)
                                throws InvalidParameterException,
                                       MissingParameterException,
                                       OperationFailedException

Retrieves learning objectives from a given repository of a given type and state.

Parameters:

loRepositoryKey - repository identifier

loTypeKey - learning objective type identifier

loStateKey - learning objective state identifier

Returns:

list of learning objectives

Throws:

InvalidParameterException - one or more parameters invalid

MissingParameterException - one or more missing parameters missing

OperationFailedException - unable to complete request

getLoCategoriesForLo

List<LoCategoryInfo> getLoCategoriesForLo(String loId)
                                          throws DoesNotExistException,
                                                 InvalidParameterException,
                                                 MissingParameterException,
                                                 OperationFailedException

Retrieves a list of learning objective categories for a specific learning objective.

Parameters:

loId - learning objective identifier

Returns:

list of learning objective category information

Throws:

DoesNotExistException - loCategoryId not found

InvalidParameterException - invalid loId

MissingParameterException - missing loId

OperationFailedException - unable to complete request

getLosByLoCategory

List<LoInfo> getLosByLoCategory(String loCategoryId)
                                throws DoesNotExistException,
                                       InvalidParameterException,
                                       MissingParameterException,
                                       OperationFailedException

Retrieves a list of learning objectives that have a specific learning objective category.

Parameters:

loCategoryId - learning objective category identifier

Returns:

list of learning objective information

Throws:

DoesNotExistException - loCategoryId not found

InvalidParameterException - invalid loCategoryId

MissingParameterException - missing loCategoryId

OperationFailedException - unable to complete request

getLosByRelatedLoId

List<LoInfo> getLosByRelatedLoId(String relatedLoId,
                                 String loLoRelationType)
                                 throws DoesNotExistException,
                                        InvalidParameterException,
                                        MissingParameterException,
                                        OperationFailedException

Retrieves the list of LO information for the LOs related to a specified LO Id with a certain LU to LU relation type (getRelatedLosByLoId from the other direction)

Parameters:

relatedLoId - identifier of the LO

loLoRelationType - the LO to LO relation type

Returns:

list of LO information

Throws:

DoesNotExistException - relatedLoId, loLoRelationType not found

InvalidParameterException - invalid relatedLoId, loLoRelationType

MissingParameterException - missing relatedLoId, loLoRelationType

OperationFailedException - unable to complete request

getRelatedLosByLoId

List<LoInfo> getRelatedLosByLoId(String loId,
                                 String loLoRelationType)
                                 throws DoesNotExistException,
                                        InvalidParameterException,
                                        MissingParameterException,
                                        OperationFailedException

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

Parameters:

loId - identifier of the LO

loLoRelationType - the LO to LO relation type

Returns:

list of LO information

Throws:

DoesNotExistException - loId, loLoRelationType not found

InvalidParameterException - invalid loId, loLoRelationType

MissingParameterException - missing loId, loLoRelationType

OperationFailedException - unable to complete request

getLoLoRelation

LoLoRelationInfo getLoLoRelation(String loLoRelationId)
                                 throws DoesNotExistException,
                                        InvalidParameterException,
                                        MissingParameterException,
                                        OperationFailedException

Retrieves the relationship information between LOs for a particular relationship identifier

Parameters:

loLoRelationId - identifier of the LO to LO relationship

Returns:

information on the relation between two LOs

Throws:

DoesNotExistException - loLoRelationId not found

InvalidParameterException - invalid loLoRelationId

MissingParameterException - missing loLoRelationId

OperationFailedException - unable to complete request

getLoLoRelationsByLoId

List<LoLoRelationInfo> getLoLoRelationsByLoId(String loId)
                                              throws DoesNotExistException,
                                                     InvalidParameterException,
                                                     MissingParameterException,
                                                     OperationFailedException

Retrieves the relationship information between LOs for a particular LO.

Parameters:

loId - identifier of the LO

Returns:

all relations (both directions) from an LO

Throws:

DoesNotExistException - loId not found

InvalidParameterException - invalid loId

MissingParameterException - missing loId

OperationFailedException - unable to complete request

validateLoCategory

List<ValidationResultInfo> validateLoCategory(String validationType,
                                              LoCategoryInfo loCategoryInfo)
                                              throws DoesNotExistException,
                                                     InvalidParameterException,
                                                     MissingParameterException,
                                                     OperationFailedException

Validates a learning objective category. 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 learning objective category (and/or one of its contained sub-objects) and a record is found for that identifier, the validation checks if the learning objective category 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

loCategoryInfo - learning objective category information to be tested.

Returns:

results from performing the validation

Throws:

DoesNotExistException - validationTypeKey not found

InvalidParameterException - invalid validationTypeKey, loCategoryInfo

MissingParameterException - missing validationTypeKey, loCategoryInfo

OperationFailedException - unable to complete request

createLoCategory

LoCategoryInfo createLoCategory(String loRepositoryKey,
                                String loCategoryTypeKey,
                                LoCategoryInfo loCategoryInfo)
                                throws DataValidationErrorException,
                                       DoesNotExistException,
                                       InvalidParameterException,
                                       MissingParameterException,
                                       OperationFailedException,
                                       PermissionDeniedException

Create a learning objective category in a particular learning objective repository.

Parameters:

loRepositoryKey - identifier of the learning objective repository

loCategoryTypeKey - identifier of the learning objective category type

loCategoryInfo - information to create the learning objective category

Returns:

information on the created learning objective category

Throws:

DataValidationErrorException - One or more values invalid for this operation

DoesNotExistException - loRepositoryKey, loCategoryTypeKey not found

InvalidParameterException - invalid loRepositoryKey, loCategoryTypeKey, loCategoryInfo

MissingParameterException - missing loRepositoryKey, loCategoryTypeKey, loCategoryInfo

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

updateLoCategory

LoCategoryInfo updateLoCategory(String loCategoryId,
                                LoCategoryInfo loCategoryInfo)
                                throws DataValidationErrorException,
                                       DoesNotExistException,
                                       InvalidParameterException,
                                       MissingParameterException,
                                       OperationFailedException,
                                       PermissionDeniedException,
                                       VersionMismatchException

Updates a learning objective category in a particular learning objective repository.

Parameters:

loCategoryId - the learning objective category identifier

loCategoryInfo - information to create the learning objective category

Returns:

information on the uppdated learning objective category

Throws:

DataValidationErrorException - One or more values invalid for this operation

DoesNotExistException - loCategoryId not found

InvalidParameterException - invalid loCategoryId, loCategoryInfo

MissingParameterException - missing loCategoryId, loCategoryInfo

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

VersionMismatchException - action was attempted on an out of date version.

deleteLoCategory

StatusInfo deleteLoCategory(String loCategoryId)
                            throws DependentObjectsExistException,
                                   DoesNotExistException,
                                   InvalidParameterException,
                                   MissingParameterException,
                                   OperationFailedException,
                                   PermissionDeniedException

Deletes a learning objective category.

Parameters:

loCategoryId - learning objective category identifier

Returns:

status of the operation (success/failure)

Throws:

DependentObjectsExistException - learning objective category is still attached to one or more learning objectives

DoesNotExistException - loCategoryId not found

InvalidParameterException - invalid loCategoryId

MissingParameterException - missing loCategoryId

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

validateLo

List<ValidationResultInfo> validateLo(String validationType,
                                      LoInfo loInfo)
                                      throws DoesNotExistException,
                                             InvalidParameterException,
                                             MissingParameterException,
                                             OperationFailedException

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

loInfo - learning objective information to be tested.

Returns:

results from performing the validation

Throws:

DoesNotExistException - validationTypeKey not found

InvalidParameterException - invalid validationTypeKey, loInfo

MissingParameterException - missing validationTypeKey, loInfo

OperationFailedException - unable to complete request

createLo

LoInfo createLo(String loRepositoryKey,
                String loType,
                LoInfo loInfo)
                throws DataValidationErrorException,
                       DoesNotExistException,
                       InvalidParameterException,
                       MissingParameterException,
                       OperationFailedException,
                       PermissionDeniedException

Create a learning objective.

Parameters:

loRepositoryKey - identifier of the learning objective repository

loType - type for the learning objective

loInfo - information to create the learning objective

Returns:

information on the created learning objective

Throws:

DataValidationErrorException - One or more values invalid for this operation

DoesNotExistException - loRepositoryKey, loType not found

InvalidParameterException - invalid loRepositoryKey, loType, loInfo

MissingParameterException - missing loRepositoryKey, loType, loInfo

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

updateLo

LoInfo updateLo(String loId,
                LoInfo loInfo)
                throws DataValidationErrorException,
                       DoesNotExistException,
                       InvalidParameterException,
                       MissingParameterException,
                       OperationFailedException,
                       PermissionDeniedException,
                       VersionMismatchException

Update a learning objective.

Parameters:

loId - identifier of the learning objective to update

loInfo - updated information on the learning objective

Returns:

information on the updated learning objective

Throws:

DataValidationErrorException - One or more values invalid for this operation

DoesNotExistException - loId not found

InvalidParameterException - invalid loId, loInfo

MissingParameterException - missing loId, loInfo

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

VersionMismatchException - action was attempted on an out of date version.

deleteLo

StatusInfo deleteLo(String loId)
                    throws DependentObjectsExistException,
                           DoesNotExistException,
                           InvalidParameterException,
                           MissingParameterException,
                           OperationFailedException,
                           PermissionDeniedException

Delete a learning objective.

Parameters:

loId - identifier of the learning objective to delete

Returns:

status of the operation (success or failure)

Throws:

DependentObjectsExistException - removing the learning objective will orphan one or more child learning objectives

DoesNotExistException - loId not found

InvalidParameterException - invalid loId

MissingParameterException - missing loId

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

addLoCategoryToLo

StatusInfo addLoCategoryToLo(String loCategoryId,
                             String loId)
                             throws AlreadyExistsException,
                                    DoesNotExistException,
                                    InvalidParameterException,
                                    MissingParameterException,
                                    OperationFailedException,
                                    PermissionDeniedException,
                                    UnsupportedActionException

Add a existing learning objective category to an existing learning objective in the same repository.

Parameters:

loCategoryId - identifier of the learning objective category to add

loId - identifier of the learning objective

Returns:

status of the operation (success or failure)

Throws:

AlreadyExistsException - loCategoryId is already set as a category of the LoId

DoesNotExistException - loId, loCategoryId not found

InvalidParameterException - invalid loId, loCategoryId

MissingParameterException - missing loId, loCategoryId

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedActionException - loId, loCategoryId are not in the same repository

removeLoCategoryFromLo

StatusInfo removeLoCategoryFromLo(String loCategoryId,
                                  String loId)
                                  throws DoesNotExistException,
                                         InvalidParameterException,
                                         MissingParameterException,
                                         OperationFailedException,
                                         PermissionDeniedException,
                                         UnsupportedActionException

Remove a existing learning objective category from an existing learning objective in the same repository.

Parameters:

loCategoryId - identifier of the learning objective category to remove

loId - identifier of the learning objective

Returns:

status of the operation (success or failure)

Throws:

DoesNotExistException - loId, loCategoryId not found

InvalidParameterException - invalid loId, loCategoryId

MissingParameterException - missing loId, loCategoryId

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedActionException - loId, loCategoryId are not in the same repository

validateLoLoRelation

List<ValidationResultInfo> validateLoLoRelation(String validationType,
                                                LoLoRelationInfo loLoRelationInfo)
                                                throws DoesNotExistException,
                                                       InvalidParameterException,
                                                       MissingParameterException,
                                                       OperationFailedException

Validates a loLoRelation. 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 loLoRelation (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

loLoRelationInfo - loLoRelation information to be tested.

Returns:

results from performing the validation

Throws:

DoesNotExistException - validationTypeKey not found

InvalidParameterException - invalid validationTypeKey, loLoRelationInfo

MissingParameterException - missing validationTypeKey, loLoRelationInfo

OperationFailedException - unable to complete request

createLoLoRelation

LoLoRelationInfo createLoLoRelation(String loId,
                                    String relatedLoId,
                                    String loLoRelationType,
                                    LoLoRelationInfo loLoRelationInfo)
                                    throws AlreadyExistsException,
                                           CircularRelationshipException,
                                           DataValidationErrorException,
                                           DoesNotExistException,
                                           InvalidParameterException,
                                           MissingParameterException,
                                           OperationFailedException,
                                           PermissionDeniedException

Create a directional relationship between two LOs

Parameters:

loId - identifier of the first LO in the relationship - The From or Parent of the relation

relatedLoId - identifier of the second LO in the relationship to be related to - the To or Child of the Relation

loLoRelationType - the type of the LO to LO relationship

loLoRelationInfo - information about the relationship between the two LOs

Returns:

the created LO to LO relation information

Throws:

AlreadyExistsException - relationship already exists

CircularRelationshipException - Relation would create a loop (with ancestor Lo)

DataValidationErrorException - One or more values invalid for this operation

DoesNotExistException - loId, relatedLoId, luLuRelationType not found

InvalidParameterException - invalid loId, relatedLoId, luluRelationType, loLoRelationInfo

MissingParameterException - missing loId, relatedLoId, luluRelationType, loLoRelationInfo

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

updateLoLoRelation

LoLoRelationInfo updateLoLoRelation(String loLoRelationId,
                                    LoLoRelationInfo loLoRelationInfo)
                                    throws DataValidationErrorException,
                                           DoesNotExistException,
                                           InvalidParameterException,
                                           MissingParameterException,
                                           OperationFailedException,
                                           PermissionDeniedException,
                                           VersionMismatchException

Updates a relationship between two LOs

Parameters:

loLoRelationId - identifier of the LO to LO relation to be updated

loLoRelationInfo - changed information about the LO to LO relationship

Returns:

the updated LO to LO relation information

Throws:

DataValidationErrorException - One or more values invalid for this operation

DoesNotExistException - loLoRelationId not found

InvalidParameterException - invalid loLoRelationId, loLoRelationInfo

MissingParameterException - missing loLoRelationId, loLoRelationInfo

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

VersionMismatchException - The action was attempted on an out of date version.

deleteLoLoRelation

StatusInfo deleteLoLoRelation(String loLoRelationId)
                              throws DoesNotExistException,
                                     InvalidParameterException,
                                     MissingParameterException,
                                     OperationFailedException,
                                     PermissionDeniedException

Deletes a relationship between two LOs

Parameters:

loLoRelationId - identifier of LO to LO relationship to delete

Returns:

status of the operation (success or failure)

Throws:

DoesNotExistException - loLoRelationId not found

InvalidParameterException - invalid loLoRelationId

MissingParameterException - missing loLoRelationId

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

DependentObjectsExistException