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

All Superinterfaces:
SearchService
All Known Implementing Classes:
LearningObjectiveServiceImpl

public interface LearningObjectiveService
extends SearchService

The Learning Objective Service allows for the creation and management of Learning Objectives.

Version:
2.0

Method Summary
 StatusInfo addLoCategoryToLo(String loCategoryId, String loId, ContextInfo contextInfo)
          Adds a LoCategory to a Lo
 LoInfo createLo(String repositoryId, String loType, LoInfo loInfo, ContextInfo contextInfo)
          Creates a new Lo.
 LoCategoryInfo createLoCategory(String loCategoryTypeKey, LoCategoryInfo loCategoryInfo, ContextInfo contextInfo)
          Creates a new LoCategory.
 LoLoRelationInfo createLoLoRelation(String loLoRelationTypeKey, LoLoRelationInfo loLoRelationInfo, ContextInfo contextInfo)
          Creates a new LoLoRelation.
 LoRepositoryInfo createLoRepository(String loRepositoryKey, String loRepositoryTypeKey, LoRepositoryInfo loRepositoryInfo, ContextInfo contextInfo)
          Creates a new LoRepository.
 StatusInfo deleteLo(String loId, ContextInfo contextInfo)
          Deletes an existing Lo.
 StatusInfo deleteLoCategory(String loCategoryId, ContextInfo contextInfo)
          Deletes an existing LoCategory.
 StatusInfo deleteLoCategoryByLo(String loId, ContextInfo contextInfo)
          Deletes existing LoCategories of a Lo.
 StatusInfo deleteLoLoRelation(String loLoRelationId, ContextInfo contextInfo)
          Deletes an existing LoLoRelation.
 StatusInfo deleteLoRepository(String loRepositoryKey, ContextInfo contextInfo)
          Deletes an existing LoRepository.
 LoInfo getLo(String loId, ContextInfo contextInfo)
          Retrieves a single Lo by an Lo Id.
 List<LoCategoryInfo> getLoCategoriesByIds(List<String> loCategoryIds, ContextInfo contextInfo)
          Retrieves a list of LoCategories from a list of LoCategory Ids.
 List<LoCategoryInfo> getLoCategoriesByLo(String loId, ContextInfo contextInfo)
          Retrieves a list of LoCategories by Lo.
 List<LoCategoryInfo> getLoCategoriesByLoRepository(String loRepositoryKey, ContextInfo contextInfo)
          Retrieves a list of LoCategories by their associated repository key
 LoCategoryInfo getLoCategory(String loCategoryId, ContextInfo contextInfo)
          Retrieves a single LoCategory by an LoCategory Id.
 List<String> getLoCategoryIdsByType(String loCategoryTypeKey, ContextInfo contextInfo)
          Retrieves a list of LoCategory Ids by LoCategory Type.
 TypeInfo getLoCategoryType(String loCategoryTypeKey, ContextInfo contextInfo)
          Deprecated. 
 List<TypeInfo> getLoCategoryTypes()
          Deprecated. 
 List<String> getLoIdsByType(String loTypeKey, ContextInfo contextInfo)
          Retrieves a list of Lo Ids by Lo Type.
 LoLoRelationInfo getLoLoRelation(String loLoRelationId, ContextInfo contextInfo)
          Retrieves a single LoLoRelation by an LoLoRelation Id.
 List<String> getLoLoRelationIdsByType(String loLoRelationTypeKey, ContextInfo contextInfo)
          Retrieves a list of LoLoRelation Ids by LoLoRelation Type.
 List<LoLoRelationInfo> getLoLoRelationsByIds(List<String> loLoRelationIds, ContextInfo contextInfo)
          Retrieves a list of LoLoRelations from a list of LoLoRelation Ids.
 List<LoLoRelationInfo> getLoLoRelationsByLoId(String loId, ContextInfo contextInfo)
          Retrieves a list of LoLoRelations by Lo.
 List<LoRepositoryInfo> getLoRepositories(ContextInfo contextInfo)
          Retrieves a list of LoRepositories.
 List<LoRepositoryInfo> getLoRepositoriesByKeys(List<String> loRepositoryKeys, ContextInfo contextInfo)
          Retrieves a list of LoRepositories from a list of LoRepository Keys.
 LoRepositoryInfo getLoRepository(String loRepositoryKey, ContextInfo contextInfo)
          Retrieves a single LoRepository by an LoRepository Key.
 List<String> getLoRepositoryKeysByType(String loRepositoryTypeKey, ContextInfo contextInfo)
          Retrieves a list of LoRepository keys by LoRepository Type.
 List<LoInfo> getLosByIds(List<String> loIds, ContextInfo contextInfo)
          Retrieves a list of Los from a list of Lo Ids.
 List<LoInfo> getLosByLoCategory(String loCategoryId, ContextInfo contextInfo)
          Retrieves a list of Los by LoCategory.
 List<LoInfo> getLosByLoRepository(String loRepositoryKey, String loTypeKey, String loStateKey, ContextInfo contextInfo)
          Retrieves a list of Los by LoRepository.
 List<LoInfo> getLosByRelatedLoId(String relatedLoId, String loLoRelationTypeKey, ContextInfo contextInfo)
          Retrieves a list of Los by related Lo.
 List<LoInfo> getRelatedLosByLoId(String loId, String loLoRelationTypeKey, ContextInfo contextInfo)
          Retrieves a list of related Los by Lo.
 StatusInfo removeLoCategoryFromLo(String loCategoryId, String loId, ContextInfo contextInfo)
          Removes a LoCategory from a Lo
 List<LoCategoryInfo> searchForLoCategories(QueryByCriteria criteria, ContextInfo contextInfo)
          Searches for LoCategories that meet the given search criteria.
 List<String> searchForLoCategoryIds(QueryByCriteria criteria, ContextInfo contextInfo)
          Searches for LoCategories that meet the given search criteria.
 List<String> searchForLoIds(QueryByCriteria criteria, ContextInfo contextInfo)
          Searches for Los that meet the given search criteria.
 List<String> searchForLoLoRelationIds(QueryByCriteria criteria, ContextInfo contextInfo)
          Searches for LoLoRelations that meet the given search criteria.
 List<LoLoRelationInfo> searchForLoLoRelations(QueryByCriteria criteria, ContextInfo contextInfo)
          Searches for LoLoRelations that meet the given search criteria.
 List<LoRepositoryInfo> searchForLoRepositories(QueryByCriteria criteria, ContextInfo contextInfo)
          Searches for LoRepositories that meet the given search criteria.
 List<String> searchForLoRepositoryKeys(QueryByCriteria criteria, ContextInfo contextInfo)
          Searches for LoRepositories that meet the given search criteria.
 List<LoInfo> searchForLos(QueryByCriteria criteria, ContextInfo contextInfo)
          Searches for Los that meet the given search criteria.
 LoInfo updateLo(String loId, LoInfo loInfo, ContextInfo contextInfo)
          Updates an existing Lo.
 LoCategoryInfo updateLoCategory(String loCategoryId, LoCategoryInfo loCategoryInfo, ContextInfo contextInfo)
          Updates an existing LoCategory.
 LoLoRelationInfo updateLoLoRelation(String loLoRelationId, LoLoRelationInfo loLoRelationInfo, ContextInfo contextInfo)
          Updates an existing LoLoRelation.
 LoRepositoryInfo updateLoRepository(String loRepositoryKey, LoRepositoryInfo loRepositoryInfo, ContextInfo contextInfo)
          Updates an existing LoRepository.
 List<ValidationResultInfo> validateLo(String validationTypeKey, LoInfo loInfo, ContextInfo contextInfo)
          Validates an Lo.
 List<ValidationResultInfo> validateLoCategory(String validationTypeKey, LoCategoryInfo loCategoryInfo, ContextInfo contextInfo)
          Validates an LoCategory.
 List<ValidationResultInfo> validateLoLoRelation(String validationTypeKey, LoLoRelationInfo loLoRelationInfo, ContextInfo contextInfo)
          Validates an LoLoRelation.
 List<ValidationResultInfo> validateLoRepository(String validationTypeKey, String loRepositoryTypeKey, LoRepositoryInfo loRepositoryInfo, ContextInfo contextInfo)
          Validates an LoRepository.
 
Methods inherited from interface org.kuali.student.r2.core.search.service.SearchService
getSearchType, getSearchTypes, search
 

Method Detail

getLoRepository

LoRepositoryInfo getLoRepository(String loRepositoryKey,
                                 ContextInfo contextInfo)
                                 throws DoesNotExistException,
                                        InvalidParameterException,
                                        MissingParameterException,
                                        OperationFailedException,
                                        PermissionDeniedException
Retrieves a single LoRepository by an LoRepository Key.

Parameters:
loRepositoryKey - the identifier for the LoRepository to be retrieved
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
the LoRepository requested
Throws:
DoesNotExistException - loRepositoryKey is not found
InvalidParameterException - contextInfo is not valid
MissingParameterException - loRepositoryKey or contextInfo is missing or null
OperationFailedException - unable to complete request
PermissionDeniedException - an authorization failure occurred

getLoRepositoriesByKeys

List<LoRepositoryInfo> getLoRepositoriesByKeys(List<String> loRepositoryKeys,
                                               ContextInfo contextInfo)
                                               throws DoesNotExistException,
                                                      InvalidParameterException,
                                                      MissingParameterException,
                                                      OperationFailedException,
                                                      PermissionDeniedException
Retrieves a list of LoRepositories from a list of LoRepository Keys. The returned list may be in any order and if duplicate Ids are supplied, a unique set may or may not be returned.

Parameters:
loRepositoryKeys - a list of LoRepository Keys
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
a list of LoRepositories
Throws:
DoesNotExistException - an loRepositoryKey in the list was not found
InvalidParameterException - contextInfo is not valid
MissingParameterException - loRepositoryKeys, a key in the loRepositoryKeys, or contextInfo is missing or null
OperationFailedException - unable to complete request
PermissionDeniedException - an authorization failure occurred

getLoRepositories

List<LoRepositoryInfo> getLoRepositories(ContextInfo contextInfo)
                                         throws InvalidParameterException,
                                                MissingParameterException,
                                                OperationFailedException,
                                                PermissionDeniedException
Retrieves a list of LoRepositories.

Parameters:
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
a list of LoRepositories or an empty list if none found
Throws:
InvalidParameterException - contextInfo is not valid
MissingParameterException - contextInfo is missing or null
OperationFailedException - unable to complete request
PermissionDeniedException - an authorization failure occurred

getLoRepositoryKeysByType

List<String> getLoRepositoryKeysByType(String loRepositoryTypeKey,
                                       ContextInfo contextInfo)
                                       throws InvalidParameterException,
                                              MissingParameterException,
                                              OperationFailedException,
                                              PermissionDeniedException
Retrieves a list of LoRepository keys by LoRepository Type.

Parameters:
loRepositoryTypeKey - a unique key for an LoRepository Type
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
a list of LoRepository keys matching loRepositoryTypeKey or an empty list if none found
Throws:
InvalidParameterException - contextInfo is not valid
MissingParameterException - loRepositoryTypeKey or context is missing or null
OperationFailedException - unable to complete request
PermissionDeniedException - an authorization failure occurred

searchForLoRepositoryKeys

List<String> searchForLoRepositoryKeys(QueryByCriteria criteria,
                                       ContextInfo contextInfo)
                                       throws InvalidParameterException,
                                              MissingParameterException,
                                              OperationFailedException,
                                              PermissionDeniedException
Searches for LoRepositories that meet the given search criteria.

Parameters:
criteria - the search criteria
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
a list of LoRepository keys matching the criteria
Throws:
InvalidParameterException - criteria or contextInfo is not valid
MissingParameterException - criteria or contextInfo is missing or null
OperationFailedException - unable to complete request
PermissionDeniedException - an authorization failure occurred

searchForLoRepositories

List<LoRepositoryInfo> searchForLoRepositories(QueryByCriteria criteria,
                                               ContextInfo contextInfo)
                                               throws InvalidParameterException,
                                                      MissingParameterException,
                                                      OperationFailedException,
                                                      PermissionDeniedException
Searches for LoRepositories that meet the given search criteria.

Parameters:
criteria - the search criteria
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
a list of LoRepositories matching the criteria
Throws:
InvalidParameterException - criteria or context is not valid
MissingParameterException - criteria or context is missing or null
OperationFailedException - unable to complete request
PermissionDeniedException - an authorization failure occurred

validateLoRepository

List<ValidationResultInfo> validateLoRepository(String validationTypeKey,
                                                String loRepositoryTypeKey,
                                                LoRepositoryInfo loRepositoryInfo,
                                                ContextInfo contextInfo)
                                                throws DoesNotExistException,
                                                       InvalidParameterException,
                                                       MissingParameterException,
                                                       OperationFailedException,
                                                       PermissionDeniedException
Validates an LoRepository. Depending on the value of validationType, this validation could be limited to tests on just the current LoRepository and its directly contained sub-objects or expanded to perform all tests related to this LoRepository. If an identifier is present for the LoRepository (and/or one of its contained sub-objects) and a record is found for that identifier, the validation checks if the LoRepository can be updated to the new values. If an identifier is not present or a record does not exist, the validation checks if the LoRepository with the given data can be created.

Parameters:
validationTypeKey - the identifier for the validation Type
loRepositoryTypeKey - the identifier for the LoRepository Type
loRepositoryInfo - the LoRepository to be validated
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
a list of validation results or an empty list if validation succeeded
Throws:
DoesNotExistException - validationTypeKey or loRepositoryTypeKey is not found
InvalidParameterException - loRepositoryInfo or contextInfo is not valid
MissingParameterException - validationTypeKey, loRepositoryTypeKey, loRepositoryInfo, or contextInfo is missing or null
OperationFailedException - unable to complete request
PermissionDeniedException - an authorization failure occurred

createLoRepository

LoRepositoryInfo createLoRepository(String loRepositoryKey,
                                    String loRepositoryTypeKey,
                                    LoRepositoryInfo loRepositoryInfo,
                                    ContextInfo contextInfo)
                                    throws AlreadyExistsException,
                                           DataValidationErrorException,
                                           DoesNotExistException,
                                           InvalidParameterException,
                                           MissingParameterException,
                                           OperationFailedException,
                                           PermissionDeniedException,
                                           ReadOnlyException
Creates a new LoRepository. The LoRepository Type, and Meta information may not be set in the supplied data object.

Parameters:
loRepositoryKey - a unique key for the new LoRepository
loRepositoryTypeKey - the identifier for the Type of LoRepository to be created
loRepositoryInfo - the data with which to create the LoRepository
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
the new LoRepository
Throws:
AlreadyExistsException - loRepositoryKey already exists
DataValidationErrorException - supplied data is invalid
DoesNotExistException - loRepositoryTypeKey does not exist or is not supported
InvalidParameterException - loRepositoryInfo or contextInfo is not valid
MissingParameterException - loRepositoryTypeKey, loRepositoryInfo, or contextInfo is missing or null
OperationFailedException - unable to complete request
PermissionDeniedException - an authorization failure occurred
ReadOnlyException - an attempt at supplying information designated as read only

updateLoRepository

LoRepositoryInfo updateLoRepository(String loRepositoryKey,
                                    LoRepositoryInfo loRepositoryInfo,
                                    ContextInfo contextInfo)
                                    throws DataValidationErrorException,
                                           DoesNotExistException,
                                           InvalidParameterException,
                                           MissingParameterException,
                                           OperationFailedException,
                                           PermissionDeniedException,
                                           ReadOnlyException,
                                           VersionMismatchException
Updates an existing LoRepository. The LoRepository Key, Type, and Meta information may not be changed.

Parameters:
loRepositoryKey - the identifier for the LoRepository to be updated
loRepositoryInfo - the new data for the LoRepository
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
the updated LoRepository
Throws:
DataValidationErrorException - supplied data is invalid
DoesNotExistException - loRepositoryKey is not found
InvalidParameterException - loRepositoryInfo or contextInfo is not valid
MissingParameterException - loRepositoryKey, loRepositoryInfo, or contextInfo is missing or null
OperationFailedException - unable to complete request
PermissionDeniedException - an authorization failure occurred
ReadOnlyException - an attempt at changing information designated as read only
VersionMismatchException - an optimistic locking failure or the action was attempted on an out of date version

deleteLoRepository

StatusInfo deleteLoRepository(String loRepositoryKey,
                              ContextInfo contextInfo)
                              throws DoesNotExistException,
                                     InvalidParameterException,
                                     MissingParameterException,
                                     OperationFailedException,
                                     PermissionDeniedException
Deletes an existing LoRepository.

Parameters:
loRepositoryKey - the identifier for the LoRepository to be deleted
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
the status of the delete operation. This must always be true.
Throws:
DoesNotExistException - loRepositoryKey is not found
InvalidParameterException - contextInfo is not valid
MissingParameterException - loRepositoryKey or contextInfo is missing or null
OperationFailedException - unable to complete request
PermissionDeniedException - an authorization failure occurred

getLo

LoInfo getLo(String loId,
             ContextInfo contextInfo)
             throws DoesNotExistException,
                    InvalidParameterException,
                    MissingParameterException,
                    OperationFailedException,
                    PermissionDeniedException
Retrieves a single Lo by an Lo Id.

Parameters:
loId - the identifier for the Lo to be retrieved
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
the Lo requested
Throws:
DoesNotExistException - loId is not found
InvalidParameterException - contextInfo is not valid
MissingParameterException - loId or contextInfo is missing or null
OperationFailedException - unable to complete request
PermissionDeniedException - an authorization failure occurred

getLosByIds

List<LoInfo> getLosByIds(List<String> loIds,
                         ContextInfo contextInfo)
                         throws DoesNotExistException,
                                InvalidParameterException,
                                MissingParameterException,
                                OperationFailedException,
                                PermissionDeniedException
Retrieves a list of Los from a list of Lo Ids. The returned list may be in any order and if duplicate Ids are supplied, a unique set may or may not be returned.

Parameters:
loIds - a list of Lo identifiers
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
a list of Los
Throws:
DoesNotExistException - an loId in the list was not found
InvalidParameterException - contextInfo is not valid
MissingParameterException - loIds, an Id in the loIds, or contextInfo is missing or null
OperationFailedException - unable to complete request
PermissionDeniedException - an authorization failure occurred

getLoIdsByType

List<String> getLoIdsByType(String loTypeKey,
                            ContextInfo contextInfo)
                            throws InvalidParameterException,
                                   MissingParameterException,
                                   OperationFailedException,
                                   PermissionDeniedException
Retrieves a list of Lo Ids by Lo Type.

Parameters:
loTypeKey - an identifier for an Lo Type
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
a list of Lo identifiers matching loTypeKey or an empty list if none found
Throws:
InvalidParameterException - contextInfo is not valid
MissingParameterException - loTypeKey or context is missing or null
OperationFailedException - unable to complete request
PermissionDeniedException - an authorization failure occurred

getLosByLoRepository

List<LoInfo> getLosByLoRepository(String loRepositoryKey,
                                  String loTypeKey,
                                  String loStateKey,
                                  ContextInfo contextInfo)
                                  throws DoesNotExistException,
                                         InvalidParameterException,
                                         MissingParameterException,
                                         OperationFailedException,
                                         PermissionDeniedException
Retrieves a list of Los by LoRepository.

Parameters:
loRepositoryKey - a key for the LoRepository
loTypeKey - the identifier for the Lo Type
loStateKey - the identifier for the Lo State
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
a list of Los for the LoRepository
Throws:
DoesNotExistException - loRepositoryId is not found
InvalidParameterException - contextInfo is not valid
MissingParameterException - loRepositoryId or contextInfo is missing or null
OperationFailedException - unable to complete request
PermissionDeniedException - an authorization failure occurred

getLosByLoCategory

List<LoInfo> getLosByLoCategory(String loCategoryId,
                                ContextInfo contextInfo)
                                throws DoesNotExistException,
                                       InvalidParameterException,
                                       MissingParameterException,
                                       OperationFailedException,
                                       PermissionDeniedException
Retrieves a list of Los by LoCategory.

Parameters:
loCategoryId - an identifier for the LoCategory
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
a list of Los for the LoCategory
Throws:
DoesNotExistException - loCategoryId is not found
InvalidParameterException - contextInfo is not valid
MissingParameterException - loCategoryId or contextInfo is missing or null
OperationFailedException - unable to complete request
PermissionDeniedException - an authorization failure occurred

getLosByRelatedLoId

List<LoInfo> getLosByRelatedLoId(String relatedLoId,
                                 String loLoRelationTypeKey,
                                 ContextInfo contextInfo)
                                 throws DoesNotExistException,
                                        InvalidParameterException,
                                        MissingParameterException,
                                        OperationFailedException,
                                        PermissionDeniedException
Retrieves a list of Los by related Lo.

Parameters:
relatedLoId - an identifier for the related Lo
loLoRelationTypeKey - the identifier for the LoLoRelation Type
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
a list of Los for the related Lo
Throws:
DoesNotExistException - relatedLoId is not found
InvalidParameterException - contextInfo is not valid
MissingParameterException - relatedLoId, loLoRelationTypeKey, or contextInfo is missing or null
OperationFailedException - unable to complete request
PermissionDeniedException - an authorization failure occurred

getRelatedLosByLoId

List<LoInfo> getRelatedLosByLoId(String loId,
                                 String loLoRelationTypeKey,
                                 ContextInfo contextInfo)
                                 throws DoesNotExistException,
                                        InvalidParameterException,
                                        MissingParameterException,
                                        OperationFailedException,
                                        PermissionDeniedException
Retrieves a list of related Los by Lo.

Parameters:
loId - an identifier for the Lo
loLoRelationTypeKey - the identifier for the LoLoRelation Type
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
a list of related Los for the Lo
Throws:
DoesNotExistException - loId is not found
InvalidParameterException - contextInfo is not valid
MissingParameterException - loId or contextInfo is missing or null
OperationFailedException - unable to complete request
PermissionDeniedException - an authorization failure occurred

searchForLoIds

List<String> searchForLoIds(QueryByCriteria criteria,
                            ContextInfo contextInfo)
                            throws InvalidParameterException,
                                   MissingParameterException,
                                   OperationFailedException,
                                   PermissionDeniedException
Searches for Los that meet the given search criteria.

Parameters:
criteria - the search criteria
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
a list of Lo identifiers matching the criteria
Throws:
InvalidParameterException - criteria or contextInfo is not valid
MissingParameterException - criteria or contextInfo is missing or null
OperationFailedException - unable to complete request
PermissionDeniedException - an authorization failure occurred

searchForLos

List<LoInfo> searchForLos(QueryByCriteria criteria,
                          ContextInfo contextInfo)
                          throws InvalidParameterException,
                                 MissingParameterException,
                                 OperationFailedException,
                                 PermissionDeniedException
Searches for Los that meet the given search criteria.

Parameters:
criteria - the search criteria
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
a list of Los matching the criteria
Throws:
InvalidParameterException - criteria or context is not valid
MissingParameterException - criteria or context is missing or null
OperationFailedException - unable to complete request
PermissionDeniedException - an authorization failure occurred

validateLo

List<ValidationResultInfo> validateLo(String validationTypeKey,
                                      LoInfo loInfo,
                                      ContextInfo contextInfo)
                                      throws DoesNotExistException,
                                             InvalidParameterException,
                                             MissingParameterException,
                                             OperationFailedException,
                                             PermissionDeniedException
Validates an Lo. Depending on the value of validationType, this validation could be limited to tests on just the current Lo and its directly contained sub-objects or expanded to perform all tests related to this Lo. If an identifier is present for the Lo (and/or one of its contained sub-objects) and a record is found for that identifier, the validation checks if the Lo can be updated to the new values. If an identifier is not present or a record does not exist, the validation checks if the Lo with the given data can be created.

Parameters:
validationTypeKey - the identifier for the Lo Type to be validated
loInfo - the Lo to be validated
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
a list of validation results or an empty list if validation succeeded
Throws:
DoesNotExistException - validationTypeKey or loTypeKey is not found
InvalidParameterException - loInfo or contextInfo is not valid
MissingParameterException - validationTypeKey, loTypeKey, loInfo, or contextInfo is missing or null
OperationFailedException - unable to complete request
PermissionDeniedException - an authorization failure occurred

createLo

LoInfo createLo(String repositoryId,
                String loType,
                LoInfo loInfo,
                ContextInfo contextInfo)
                throws DataValidationErrorException,
                       DoesNotExistException,
                       InvalidParameterException,
                       MissingParameterException,
                       OperationFailedException,
                       PermissionDeniedException,
                       ReadOnlyException
Creates a new Lo. The Lo Id, Type, and Meta information may not be set in the supplied data object.

Parameters:
loTypeKey - the identifier for the Type of Lo to be created
string -
loInfo - the data with which to create the Lo
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
the new Lo
Throws:
DataValidationErrorException - supplied data is invalid
DoesNotExistException - loTypeKey does not exist or is not supported
InvalidParameterException - loInfo or contextInfo is not valid
MissingParameterException - loTypeKey, loInfo, or contextInfo is missing or null
OperationFailedException - unable to complete request
PermissionDeniedException - an authorization failure occurred
ReadOnlyException - an attempt at supplying information designated as read only

updateLo

LoInfo updateLo(String loId,
                LoInfo loInfo,
                ContextInfo contextInfo)
                throws DataValidationErrorException,
                       DoesNotExistException,
                       InvalidParameterException,
                       MissingParameterException,
                       OperationFailedException,
                       PermissionDeniedException,
                       ReadOnlyException,
                       VersionMismatchException
Updates an existing Lo. The Lo Id, Type, and Meta information may not be changed.

Parameters:
loId - the identifier for the Lo to be updated
loInfo - the new data for the Lo
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
the updated Lo
Throws:
DataValidationErrorException - supplied data is invalid
DoesNotExistException - loId is not found
InvalidParameterException - loInfo or contextInfo is not valid
MissingParameterException - loId, loInfo, or contextInfo is missing or null
OperationFailedException - unable to complete request
PermissionDeniedException - an authorization failure occurred
ReadOnlyException - an attempt at changing information designated as read only
VersionMismatchException - an optimistic locking failure or the action was attempted on an out of date version

deleteLo

StatusInfo deleteLo(String loId,
                    ContextInfo contextInfo)
                    throws DoesNotExistException,
                           InvalidParameterException,
                           MissingParameterException,
                           OperationFailedException,
                           PermissionDeniedException,
                           DependentObjectsExistException
Deletes an existing Lo.

Parameters:
loId - the identifier for the Lo to be deleted
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
the status of the delete operation. This must always be true.
Throws:
DoesNotExistException - loId is not found
InvalidParameterException - contextInfo is not valid
MissingParameterException - loId or contextInfo is missing or null
OperationFailedException - unable to complete request
PermissionDeniedException - an authorization failure occurred
DependentObjectsExistException

getLoCategory

LoCategoryInfo getLoCategory(String loCategoryId,
                             ContextInfo contextInfo)
                             throws DoesNotExistException,
                                    InvalidParameterException,
                                    MissingParameterException,
                                    OperationFailedException,
                                    PermissionDeniedException
Retrieves a single LoCategory by an LoCategory Id.

Parameters:
loCategoryId - the identifier for the LoCategory to be retrieved
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
the LoCategory requested
Throws:
DoesNotExistException - loCategoryId is not found
InvalidParameterException - contextInfo is not valid
MissingParameterException - loCategoryId or contextInfo is missing or null
OperationFailedException - unable to complete request
PermissionDeniedException - an authorization failure occurred

getLoCategoriesByIds

List<LoCategoryInfo> getLoCategoriesByIds(List<String> loCategoryIds,
                                          ContextInfo contextInfo)
                                          throws DoesNotExistException,
                                                 InvalidParameterException,
                                                 MissingParameterException,
                                                 OperationFailedException,
                                                 PermissionDeniedException
Retrieves a list of LoCategories from a list of LoCategory Ids. The returned list may be in any order and if duplicate Ids are supplied, a unique set may or may not be returned.

Parameters:
loCategoryIds - a list of LoCategory identifiers
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
a list of LoCategories
Throws:
DoesNotExistException - an loCategoryId in the list was not found
InvalidParameterException - contextInfo is not valid
MissingParameterException - loCategoryIds, an Id in the loCategoryIds, or contextInfo is missing or null
OperationFailedException - unable to complete request
PermissionDeniedException - an authorization failure occurred

getLoCategoriesByLoRepository

List<LoCategoryInfo> getLoCategoriesByLoRepository(String loRepositoryKey,
                                                   ContextInfo contextInfo)
                                                   throws DoesNotExistException,
                                                          InvalidParameterException,
                                                          MissingParameterException,
                                                          OperationFailedException,
                                                          PermissionDeniedException
Retrieves a list of LoCategories by their associated repository key

Parameters:
loRepositoryKey - a list of LoCategory identifiers
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
a list of LoCategories
Throws:
DoesNotExistException - an loCategoryId in the list was not found
InvalidParameterException - contextInfo is not valid
MissingParameterException - loCategoryIds, an Id in the loCategoryIds, or contextInfo is missing or null
OperationFailedException - unable to complete request
PermissionDeniedException - an authorization failure occurred

getLoCategoryIdsByType

List<String> getLoCategoryIdsByType(String loCategoryTypeKey,
                                    ContextInfo contextInfo)
                                    throws InvalidParameterException,
                                           MissingParameterException,
                                           OperationFailedException,
                                           PermissionDeniedException
Retrieves a list of LoCategory Ids by LoCategory Type.

Parameters:
loCategoryTypeKey - an identifier for an LoCategory Type
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
a list of LoCategory identifiers matching loCategoryTypeKey or an empty list if none found
Throws:
InvalidParameterException - contextInfo is not valid
MissingParameterException - loCategoryTypeKey or context is missing or null
OperationFailedException - unable to complete request
PermissionDeniedException - an authorization failure occurred

getLoCategoriesByLo

List<LoCategoryInfo> getLoCategoriesByLo(String loId,
                                         ContextInfo contextInfo)
                                         throws DoesNotExistException,
                                                InvalidParameterException,
                                                MissingParameterException,
                                                OperationFailedException,
                                                PermissionDeniedException
Retrieves a list of LoCategories by Lo.

Parameters:
loId - an identifier for the Lo
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
a list of LoCategories for the Lo
Throws:
DoesNotExistException - loId is not found
InvalidParameterException - contextInfo is not valid
MissingParameterException - loId or contextInfo is missing or null
OperationFailedException - unable to complete request
PermissionDeniedException - an authorization failure occurred

searchForLoCategoryIds

List<String> searchForLoCategoryIds(QueryByCriteria criteria,
                                    ContextInfo contextInfo)
                                    throws InvalidParameterException,
                                           MissingParameterException,
                                           OperationFailedException,
                                           PermissionDeniedException
Searches for LoCategories that meet the given search criteria.

Parameters:
criteria - the search criteria
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
a list of LoCategory identifiers matching the criteria
Throws:
InvalidParameterException - criteria or contextInfo is not valid
MissingParameterException - criteria or contextInfo is missing or null
OperationFailedException - unable to complete request
PermissionDeniedException - an authorization failure occurred

searchForLoCategories

List<LoCategoryInfo> searchForLoCategories(QueryByCriteria criteria,
                                           ContextInfo contextInfo)
                                           throws InvalidParameterException,
                                                  MissingParameterException,
                                                  OperationFailedException,
                                                  PermissionDeniedException
Searches for LoCategories that meet the given search criteria.

Parameters:
criteria - the search criteria
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
a list of LoCategories matching the criteria
Throws:
InvalidParameterException - criteria or context is not valid
MissingParameterException - criteria or context is missing or null
OperationFailedException - unable to complete request
PermissionDeniedException - an authorization failure occurred

validateLoCategory

List<ValidationResultInfo> validateLoCategory(String validationTypeKey,
                                              LoCategoryInfo loCategoryInfo,
                                              ContextInfo contextInfo)
                                              throws DoesNotExistException,
                                                     InvalidParameterException,
                                                     MissingParameterException,
                                                     OperationFailedException,
                                                     PermissionDeniedException
Validates an LoCategory. Depending on the value of validationType, this validation could be limited to tests on just the current LoCategory and its directly contained sub-objects or expanded to perform all tests related to this LoCategory. If an identifier is present for the LoCategory (and/or one of its contained sub-objects) and a record is found for that identifier, the validation checks if the LoCategory can be updated to the new values. If an identifier is not present or a record does not exist, the validation checks if the LoCategory with the given data can be created.

Parameters:
validationTypeKey - the identifier for the LoCategory Type to be validated
loCategoryInfo - the LoCategory to be validated
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
a list of validation results or an empty list if validation succeeded
Throws:
DoesNotExistException - validationTypeKey or loCategoryTypeKey is not found
InvalidParameterException - loCategoryInfo or contextInfo is not valid
MissingParameterException - validationTypeKey, loCategoryTypeKey, loCategoryInfo, or contextInfo is missing or null
OperationFailedException - unable to complete request
PermissionDeniedException - an authorization failure occurred

createLoCategory

LoCategoryInfo createLoCategory(String loCategoryTypeKey,
                                LoCategoryInfo loCategoryInfo,
                                ContextInfo contextInfo)
                                throws DataValidationErrorException,
                                       DoesNotExistException,
                                       InvalidParameterException,
                                       MissingParameterException,
                                       OperationFailedException,
                                       PermissionDeniedException,
                                       ReadOnlyException
Creates a new LoCategory. The LoCategory Id, Type, and Meta information may not be set in the supplied data object.

Parameters:
loCategoryTypeKey - the identifier for the Type of LoCategory to be created
loCategoryInfo - the data with which to create the LoCategory
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
the new LoCategory
Throws:
DataValidationErrorException - supplied data is invalid
DoesNotExistException - loCategoryTypeKey does not exist or is not supported
InvalidParameterException - loCategoryInfo or contextInfo is not valid
MissingParameterException - loCategoryTypeKey, loCategoryInfo, or contextInfo is missing or null
OperationFailedException - unable to complete request
PermissionDeniedException - an authorization failure occurred
ReadOnlyException - an attempt at supplying information designated as read only

updateLoCategory

LoCategoryInfo updateLoCategory(String loCategoryId,
                                LoCategoryInfo loCategoryInfo,
                                ContextInfo contextInfo)
                                throws DataValidationErrorException,
                                       DoesNotExistException,
                                       InvalidParameterException,
                                       MissingParameterException,
                                       OperationFailedException,
                                       PermissionDeniedException,
                                       ReadOnlyException,
                                       VersionMismatchException
Updates an existing LoCategory. The LoCategory Id, Type, and Meta information may not be changed.

Parameters:
loCategoryId - the identifier for the LoCategory to be updated
loCategoryInfo - the new data for the LoCategory
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
the updated LoCategory
Throws:
DataValidationErrorException - supplied data is invalid
DoesNotExistException - loCategoryId is not found
InvalidParameterException - loCategoryInfo or contextInfo is not valid
MissingParameterException - loCategoryId, loCategoryInfo, or contextInfo is missing or null
OperationFailedException - unable to complete request
PermissionDeniedException - an authorization failure occurred
ReadOnlyException - an attempt at changing information designated as read only
VersionMismatchException - an optimistic locking failure or the action was attempted on an out of date version

deleteLoCategory

StatusInfo deleteLoCategory(String loCategoryId,
                            ContextInfo contextInfo)
                            throws DoesNotExistException,
                                   InvalidParameterException,
                                   MissingParameterException,
                                   OperationFailedException,
                                   PermissionDeniedException,
                                   DependentObjectsExistException
Deletes an existing LoCategory.

Parameters:
loCategoryId - the identifier for the LoCategory to be deleted
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
the status of the delete operation. This must always be true.
Throws:
DoesNotExistException - loCategoryId is not found
InvalidParameterException - contextInfo is not valid
MissingParameterException - loCategoryId or contextInfo is missing or null
OperationFailedException - unable to complete request
PermissionDeniedException - an authorization failure occurred
DependentObjectsExistException

deleteLoCategoryByLo

StatusInfo deleteLoCategoryByLo(String loId,
                                ContextInfo contextInfo)
                                throws DoesNotExistException,
                                       InvalidParameterException,
                                       MissingParameterException,
                                       OperationFailedException,
                                       PermissionDeniedException
Deletes existing LoCategories of a Lo.

Parameters:
loId - the identifier for the Lo for which LoCategories are to be deleted
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
the status of the delete operation. This must always be true.
Throws:
DoesNotExistException - loId is not found
InvalidParameterException - contextInfo is not valid
MissingParameterException - loId or contextInfo is missing or null
OperationFailedException - unable to complete request
PermissionDeniedException - an authorization failure occurred

addLoCategoryToLo

StatusInfo addLoCategoryToLo(String loCategoryId,
                             String loId,
                             ContextInfo contextInfo)
                             throws AlreadyExistsException,
                                    DoesNotExistException,
                                    InvalidParameterException,
                                    MissingParameterException,
                                    OperationFailedException,
                                    PermissionDeniedException,
                                    UnsupportedActionException
Adds a LoCategory to a Lo

Parameters:
loCategoryId - the identifier for the LoCategory
loId - the identifier for the Lo
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
the status of the delete operation. This must always be true.
Throws:
AlreadyExistsException - LoCategory already exists for Lo
DoesNotExistException - loCategoryId or loId is not found
InvalidParameterException - contextInfo is not valid
MissingParameterException - loCategoryId, loId, or contextInfo is missing or null
OperationFailedException - unable to complete request
PermissionDeniedException - an authorization failure occurred
UnsupportedActionException - loCategoryId and loId are not in the same repository

removeLoCategoryFromLo

StatusInfo removeLoCategoryFromLo(String loCategoryId,
                                  String loId,
                                  ContextInfo contextInfo)
                                  throws AlreadyExistsException,
                                         DoesNotExistException,
                                         InvalidParameterException,
                                         MissingParameterException,
                                         OperationFailedException,
                                         PermissionDeniedException,
                                         UnsupportedActionException
Removes a LoCategory from a Lo

Parameters:
loCategoryId - the identifier for the LoCategory
loId - the identifier for the Lo
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
the status of the delete operation. This must always be true.
Throws:
AlreadyExistsException - LoCategory already exists for Lo
DoesNotExistException - loCategoryId or loId is not found
InvalidParameterException - contextInfo is not valid
MissingParameterException - loCategoryId, loId, or contextInfo is missing or null
OperationFailedException - unable to complete request
PermissionDeniedException - an authorization failure occurred
UnsupportedActionException - loCategoryId and loId are not in the same repository

getLoLoRelation

LoLoRelationInfo getLoLoRelation(String loLoRelationId,
                                 ContextInfo contextInfo)
                                 throws DoesNotExistException,
                                        InvalidParameterException,
                                        MissingParameterException,
                                        OperationFailedException,
                                        PermissionDeniedException
Retrieves a single LoLoRelation by an LoLoRelation Id.

Parameters:
loLoRelationId - the identifier for the LoLoRelation to be retrieved
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
the LoLoRelation requested
Throws:
DoesNotExistException - loLoRelationId is not found
InvalidParameterException - contextInfo is not valid
MissingParameterException - loLoRelationId or contextInfo is missing or null
OperationFailedException - unable to complete request
PermissionDeniedException - an authorization failure occurred

getLoLoRelationsByIds

List<LoLoRelationInfo> getLoLoRelationsByIds(List<String> loLoRelationIds,
                                             ContextInfo contextInfo)
                                             throws DoesNotExistException,
                                                    InvalidParameterException,
                                                    MissingParameterException,
                                                    OperationFailedException,
                                                    PermissionDeniedException
Retrieves a list of LoLoRelations from a list of LoLoRelation Ids. The returned list may be in any order and if duplicate Ids are supplied, a unique set may or may not be returned.

Parameters:
loLoRelationIds - a list of LoLoRelation identifiers
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
a list of LoLoRelations
Throws:
DoesNotExistException - an loLoRelationId in the list was not found
InvalidParameterException - contextInfo is not valid
MissingParameterException - loLoRelationIds, an Id in the loLoRelationIds, or contextInfo is missing or null
OperationFailedException - unable to complete request
PermissionDeniedException - an authorization failure occurred

getLoLoRelationIdsByType

List<String> getLoLoRelationIdsByType(String loLoRelationTypeKey,
                                      ContextInfo contextInfo)
                                      throws InvalidParameterException,
                                             MissingParameterException,
                                             OperationFailedException,
                                             PermissionDeniedException
Retrieves a list of LoLoRelation Ids by LoLoRelation Type.

Parameters:
loLoRelationTypeKey - an identifier for an LoLoRelation Type
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
a list of LoLoRelation identifiers matching loLoRelationTypeKey or an empty list if none found
Throws:
InvalidParameterException - contextInfo is not valid
MissingParameterException - loLoRelationTypeKey or context is missing or null
OperationFailedException - unable to complete request
PermissionDeniedException - an authorization failure occurred

getLoLoRelationsByLoId

List<LoLoRelationInfo> getLoLoRelationsByLoId(String loId,
                                              ContextInfo contextInfo)
                                              throws DoesNotExistException,
                                                     InvalidParameterException,
                                                     MissingParameterException,
                                                     OperationFailedException,
                                                     PermissionDeniedException
Retrieves a list of LoLoRelations by Lo.

Parameters:
loId - an identifier for the Lo
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
a list of LoLoRelations for the Lo
Throws:
DoesNotExistException - loId is not found
InvalidParameterException - contextInfo is not valid
MissingParameterException - loId or contextInfo is missing or null
OperationFailedException - unable to complete request
PermissionDeniedException - an authorization failure occurred

searchForLoLoRelationIds

List<String> searchForLoLoRelationIds(QueryByCriteria criteria,
                                      ContextInfo contextInfo)
                                      throws InvalidParameterException,
                                             MissingParameterException,
                                             OperationFailedException,
                                             PermissionDeniedException
Searches for LoLoRelations that meet the given search criteria.

Parameters:
criteria - the search criteria
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
a list of LoLoRelation identifiers matching the criteria
Throws:
InvalidParameterException - criteria or contextInfo is not valid
MissingParameterException - criteria or contextInfo is missing or null
OperationFailedException - unable to complete request
PermissionDeniedException - an authorization failure occurred

searchForLoLoRelations

List<LoLoRelationInfo> searchForLoLoRelations(QueryByCriteria criteria,
                                              ContextInfo contextInfo)
                                              throws InvalidParameterException,
                                                     MissingParameterException,
                                                     OperationFailedException,
                                                     PermissionDeniedException
Searches for LoLoRelations that meet the given search criteria.

Parameters:
criteria - the search criteria
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
a list of LoLoRelations matching the criteria
Throws:
InvalidParameterException - criteria or context is not valid
MissingParameterException - criteria or context is missing or null
OperationFailedException - unable to complete request
PermissionDeniedException - an authorization failure occurred

validateLoLoRelation

List<ValidationResultInfo> validateLoLoRelation(String validationTypeKey,
                                                LoLoRelationInfo loLoRelationInfo,
                                                ContextInfo contextInfo)
                                                throws DoesNotExistException,
                                                       InvalidParameterException,
                                                       MissingParameterException,
                                                       OperationFailedException,
                                                       PermissionDeniedException
Validates an LoLoRelation. Depending on the value of validationType, this validation could be limited to tests on just the current LoLoRelation and its directly contained sub-objects or expanded to perform all tests related to this LoLoRelation. 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 LoLoRelation can be updated to the new values. If an identifier is not present or a record does not exist, the validation checks if the LoLoRelation with the given data can be created.

Parameters:
validationTypeKey - the identifier for the LoLoRelation Type to be validated
loLoRelationInfo - the LoLoRelation to be validated
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
a list of validation results or an empty list if validation succeeded
Throws:
DoesNotExistException - validationTypeKey or loLoRelationTypeKey is not found
InvalidParameterException - loLoRelationInfo or contextInfo is not valid
MissingParameterException - validationTypeKey, loLoRelationTypeKey, loLoRelationInfo, or contextInfo is missing or null
OperationFailedException - unable to complete request
PermissionDeniedException - an authorization failure occurred

createLoLoRelation

LoLoRelationInfo createLoLoRelation(String loLoRelationTypeKey,
                                    LoLoRelationInfo loLoRelationInfo,
                                    ContextInfo contextInfo)
                                    throws DataValidationErrorException,
                                           DoesNotExistException,
                                           InvalidParameterException,
                                           MissingParameterException,
                                           OperationFailedException,
                                           PermissionDeniedException,
                                           ReadOnlyException
Creates a new LoLoRelation. The LoLoRelation Id, Type, and Meta information may not be set in the supplied data object.

Parameters:
loLoRelationTypeKey - the identifier for the Type of LoLoRelation to be created
type -
relatedLoId -
loLoRelationInfo - the data with which to create the LoLoRelation
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
the new LoLoRelation
Throws:
DataValidationErrorException - supplied data is invalid
DoesNotExistException - loLoRelationTypeKey does not exist or is not supported
InvalidParameterException - loLoRelationInfo or contextInfo is not valid
MissingParameterException - loLoRelationTypeKey, loLoRelationInfo, or contextInfo is missing or null
OperationFailedException - unable to complete request
PermissionDeniedException - an authorization failure occurred
ReadOnlyException - an attempt at supplying information designated as read only

updateLoLoRelation

LoLoRelationInfo updateLoLoRelation(String loLoRelationId,
                                    LoLoRelationInfo loLoRelationInfo,
                                    ContextInfo contextInfo)
                                    throws DataValidationErrorException,
                                           DoesNotExistException,
                                           InvalidParameterException,
                                           MissingParameterException,
                                           OperationFailedException,
                                           PermissionDeniedException,
                                           ReadOnlyException,
                                           VersionMismatchException
Updates an existing LoLoRelation. The LoLoRelation Id, Type, and Meta information may not be changed.

Parameters:
loLoRelationId - the identifier for the LoLoRelation to be updated
loLoRelationInfo - the new data for the LoLoRelation
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
the updated LoLoRelation
Throws:
DataValidationErrorException - supplied data is invalid
DoesNotExistException - loLoRelationId is not found
InvalidParameterException - loLoRelationInfo or contextInfo is not valid
MissingParameterException - loLoRelationId, loLoRelationInfo, or contextInfo is missing or null
OperationFailedException - unable to complete request
PermissionDeniedException - an authorization failure occurred
ReadOnlyException - an attempt at changing information designated as read only
VersionMismatchException - an optimistic locking failure or the action was attempted on an out of date version

deleteLoLoRelation

StatusInfo deleteLoLoRelation(String loLoRelationId,
                              ContextInfo contextInfo)
                              throws DoesNotExistException,
                                     InvalidParameterException,
                                     MissingParameterException,
                                     OperationFailedException,
                                     PermissionDeniedException
Deletes an existing LoLoRelation.

Parameters:
loLoRelationId - the identifier for the LoLoRelation to be deleted
contextInfo - information containing the principalId and locale information about the caller of the service operation
Returns:
the status of the delete operation. This must always be true.
Throws:
DoesNotExistException - loLoRelationId is not found
InvalidParameterException - contextInfo is not valid
MissingParameterException - loLoRelationId or contextInfo is missing or null
OperationFailedException - unable to complete request
PermissionDeniedException - an authorization failure occurred

getLoCategoryType

@Deprecated
TypeInfo getLoCategoryType(String loCategoryTypeKey,
                                      ContextInfo contextInfo)
                           throws DoesNotExistException,
                                  InvalidParameterException,
                                  MissingParameterException,
                                  OperationFailedException
Deprecated. 

Throws:
DoesNotExistException
InvalidParameterException
MissingParameterException
OperationFailedException

getLoCategoryTypes

@Deprecated
List<TypeInfo> getLoCategoryTypes()
                                  throws OperationFailedException
Deprecated. 

Throws:
OperationFailedException


Copyright © 2004-2012 The Kuali Foundation. All Rights Reserved.