|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface LearningObjectiveService
The Learning Objective Service allows for the creation and management of Learning Objectives.
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 |
---|
LoRepositoryInfo getLoRepository(String loRepositoryKey, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
loRepositoryKey
- the identifier for the LoRepository to be retrievedcontextInfo
- information containing the principalId and locale information about the caller of the service operation
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 occurredList<LoRepositoryInfo> getLoRepositoriesByKeys(List<String> loRepositoryKeys, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
loRepositoryKeys
- a list of LoRepository KeyscontextInfo
- information containing the principalId and locale information about the caller of the service operation
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 occurredList<LoRepositoryInfo> getLoRepositories(ContextInfo contextInfo) throws InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
contextInfo
- information containing the principalId and locale information about the caller of the service operation
InvalidParameterException
- contextInfo is not valid
MissingParameterException
- contextInfo is missing or null
OperationFailedException
- unable to complete request
PermissionDeniedException
- an authorization failure occurredList<String> getLoRepositoryKeysByType(String loRepositoryTypeKey, ContextInfo contextInfo) throws InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
loRepositoryTypeKey
- a unique key for an LoRepository TypecontextInfo
- information containing the principalId and locale information about the caller of the service operation
InvalidParameterException
- contextInfo is not valid
MissingParameterException
- loRepositoryTypeKey or context is missing or null
OperationFailedException
- unable to complete request
PermissionDeniedException
- an authorization failure occurredList<String> searchForLoRepositoryKeys(QueryByCriteria criteria, ContextInfo contextInfo) throws InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
criteria
- the search criteriacontextInfo
- information containing the principalId and locale information about the caller of the service operation
InvalidParameterException
- criteria or contextInfo is not valid
MissingParameterException
- criteria or contextInfo is missing or null
OperationFailedException
- unable to complete request
PermissionDeniedException
- an authorization failure occurredList<LoRepositoryInfo> searchForLoRepositories(QueryByCriteria criteria, ContextInfo contextInfo) throws InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
criteria
- the search criteriacontextInfo
- information containing the principalId and locale information about the caller of the service operation
InvalidParameterException
- criteria or context is not valid
MissingParameterException
- criteria or context is missing or null
OperationFailedException
- unable to complete request
PermissionDeniedException
- an authorization failure occurredList<ValidationResultInfo> validateLoRepository(String validationTypeKey, String loRepositoryTypeKey, LoRepositoryInfo loRepositoryInfo, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
validationTypeKey
- the identifier for the validation TypeloRepositoryTypeKey
- the identifier for the LoRepository TypeloRepositoryInfo
- the LoRepository to be validatedcontextInfo
- information containing the principalId and locale information about the caller of the service operation
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 occurredLoRepositoryInfo createLoRepository(String loRepositoryKey, String loRepositoryTypeKey, LoRepositoryInfo loRepositoryInfo, ContextInfo contextInfo) throws AlreadyExistsException, DataValidationErrorException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, ReadOnlyException
loRepositoryKey
- a unique key for the new LoRepositoryloRepositoryTypeKey
- the identifier for the Type of LoRepository to be createdloRepositoryInfo
- the data with which to create the LoRepositorycontextInfo
- information containing the principalId and locale information about the caller of the service operation
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 onlyLoRepositoryInfo updateLoRepository(String loRepositoryKey, LoRepositoryInfo loRepositoryInfo, ContextInfo contextInfo) throws DataValidationErrorException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, ReadOnlyException, VersionMismatchException
loRepositoryKey
- the identifier for the LoRepository to be updatedloRepositoryInfo
- the new data for the LoRepositorycontextInfo
- information containing the principalId and locale information about the caller of the service operation
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 versionStatusInfo deleteLoRepository(String loRepositoryKey, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
loRepositoryKey
- the identifier for the LoRepository to be deletedcontextInfo
- information containing the principalId and locale information about the caller of the service operation
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 occurredLoInfo getLo(String loId, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
loId
- the identifier for the Lo to be retrievedcontextInfo
- information containing the principalId and locale information about the caller of the service operation
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 occurredList<LoInfo> getLosByIds(List<String> loIds, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
loIds
- a list of Lo identifierscontextInfo
- information containing the principalId and locale information about the caller of the service operation
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 occurredList<String> getLoIdsByType(String loTypeKey, ContextInfo contextInfo) throws InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
loTypeKey
- an identifier for an Lo TypecontextInfo
- information containing the principalId and locale information about the caller of the service operation
InvalidParameterException
- contextInfo is not valid
MissingParameterException
- loTypeKey or context is missing or null
OperationFailedException
- unable to complete request
PermissionDeniedException
- an authorization failure occurredList<LoInfo> getLosByLoRepository(String loRepositoryKey, String loTypeKey, String loStateKey, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
loRepositoryKey
- a key for the LoRepositoryloTypeKey
- the identifier for the Lo TypeloStateKey
- the identifier for the Lo StatecontextInfo
- information containing the principalId and locale information about the caller of the service operation
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 occurredList<LoInfo> getLosByLoCategory(String loCategoryId, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
loCategoryId
- an identifier for the LoCategorycontextInfo
- information containing the principalId and locale information about the caller of the service operation
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 occurredList<LoInfo> getLosByRelatedLoId(String relatedLoId, String loLoRelationTypeKey, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
relatedLoId
- an identifier for the related LoloLoRelationTypeKey
- the identifier for the LoLoRelation TypecontextInfo
- information containing the principalId and locale information about the caller of the service operation
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 occurredList<LoInfo> getRelatedLosByLoId(String loId, String loLoRelationTypeKey, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
loId
- an identifier for the LoloLoRelationTypeKey
- the identifier for the LoLoRelation TypecontextInfo
- information containing the principalId and locale information about the caller of the service operation
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 occurredList<String> searchForLoIds(QueryByCriteria criteria, ContextInfo contextInfo) throws InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
criteria
- the search criteriacontextInfo
- information containing the principalId and locale information about the caller of the service operation
InvalidParameterException
- criteria or contextInfo is not valid
MissingParameterException
- criteria or contextInfo is missing or null
OperationFailedException
- unable to complete request
PermissionDeniedException
- an authorization failure occurredList<LoInfo> searchForLos(QueryByCriteria criteria, ContextInfo contextInfo) throws InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
criteria
- the search criteriacontextInfo
- information containing the principalId and locale information about the caller of the service operation
InvalidParameterException
- criteria or context is not valid
MissingParameterException
- criteria or context is missing or null
OperationFailedException
- unable to complete request
PermissionDeniedException
- an authorization failure occurredList<ValidationResultInfo> validateLo(String validationTypeKey, LoInfo loInfo, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
validationTypeKey
- the identifier for the Lo Type to be validatedloInfo
- the Lo to be validatedcontextInfo
- information containing the principalId and locale information about the caller of the service operation
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 occurredLoInfo createLo(String repositoryId, String loType, LoInfo loInfo, ContextInfo contextInfo) throws DataValidationErrorException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, ReadOnlyException
loTypeKey
- the identifier for the Type of Lo to be createdstring
- loInfo
- the data with which to create the LocontextInfo
- information containing the principalId and locale information about the caller of the service operation
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 onlyLoInfo updateLo(String loId, LoInfo loInfo, ContextInfo contextInfo) throws DataValidationErrorException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, ReadOnlyException, VersionMismatchException
loId
- the identifier for the Lo to be updatedloInfo
- the new data for the LocontextInfo
- information containing the principalId and locale information about the caller of the service operation
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 versionStatusInfo deleteLo(String loId, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, DependentObjectsExistException
loId
- the identifier for the Lo to be deletedcontextInfo
- information containing the principalId and locale information about the caller of the service operation
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
LoCategoryInfo getLoCategory(String loCategoryId, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
loCategoryId
- the identifier for the LoCategory to be retrievedcontextInfo
- information containing the principalId and locale information about the caller of the service operation
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 occurredList<LoCategoryInfo> getLoCategoriesByIds(List<String> loCategoryIds, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
loCategoryIds
- a list of LoCategory identifierscontextInfo
- information containing the principalId and locale information about the caller of the service operation
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 occurredList<LoCategoryInfo> getLoCategoriesByLoRepository(String loRepositoryKey, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
loRepositoryKey
- a list of LoCategory identifierscontextInfo
- information containing the principalId and locale information about the caller of the service operation
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 occurredList<String> getLoCategoryIdsByType(String loCategoryTypeKey, ContextInfo contextInfo) throws InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
loCategoryTypeKey
- an identifier for an LoCategory TypecontextInfo
- information containing the principalId and locale information about the caller of the service operation
InvalidParameterException
- contextInfo is not valid
MissingParameterException
- loCategoryTypeKey or context is missing or null
OperationFailedException
- unable to complete request
PermissionDeniedException
- an authorization failure occurredList<LoCategoryInfo> getLoCategoriesByLo(String loId, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
loId
- an identifier for the LocontextInfo
- information containing the principalId and locale information about the caller of the service operation
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 occurredList<String> searchForLoCategoryIds(QueryByCriteria criteria, ContextInfo contextInfo) throws InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
criteria
- the search criteriacontextInfo
- information containing the principalId and locale information about the caller of the service operation
InvalidParameterException
- criteria or contextInfo is not valid
MissingParameterException
- criteria or contextInfo is missing or null
OperationFailedException
- unable to complete request
PermissionDeniedException
- an authorization failure occurredList<LoCategoryInfo> searchForLoCategories(QueryByCriteria criteria, ContextInfo contextInfo) throws InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
criteria
- the search criteriacontextInfo
- information containing the principalId and locale information about the caller of the service operation
InvalidParameterException
- criteria or context is not valid
MissingParameterException
- criteria or context is missing or null
OperationFailedException
- unable to complete request
PermissionDeniedException
- an authorization failure occurredList<ValidationResultInfo> validateLoCategory(String validationTypeKey, LoCategoryInfo loCategoryInfo, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
validationTypeKey
- the identifier for the LoCategory Type to be validatedloCategoryInfo
- the LoCategory to be validatedcontextInfo
- information containing the principalId and locale information about the caller of the service operation
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 occurredLoCategoryInfo createLoCategory(String loCategoryTypeKey, LoCategoryInfo loCategoryInfo, ContextInfo contextInfo) throws DataValidationErrorException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, ReadOnlyException
loCategoryTypeKey
- the identifier for the Type of LoCategory to be createdloCategoryInfo
- the data with which to create the LoCategorycontextInfo
- information containing the principalId and locale information about the caller of the service operation
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 onlyLoCategoryInfo updateLoCategory(String loCategoryId, LoCategoryInfo loCategoryInfo, ContextInfo contextInfo) throws DataValidationErrorException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, ReadOnlyException, VersionMismatchException
loCategoryId
- the identifier for the LoCategory to be updatedloCategoryInfo
- the new data for the LoCategorycontextInfo
- information containing the principalId and locale information about the caller of the service operation
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 versionStatusInfo deleteLoCategory(String loCategoryId, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, DependentObjectsExistException
loCategoryId
- the identifier for the LoCategory to be deletedcontextInfo
- information containing the principalId and locale information about the caller of the service operation
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
StatusInfo deleteLoCategoryByLo(String loId, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
loId
- the identifier for the Lo for which LoCategories are to be deletedcontextInfo
- information containing the principalId and locale information about the caller of the service operation
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 occurredStatusInfo addLoCategoryToLo(String loCategoryId, String loId, ContextInfo contextInfo) throws AlreadyExistsException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, UnsupportedActionException
loCategoryId
- the identifier for the LoCategoryloId
- the identifier for the LocontextInfo
- information containing the principalId and locale information about the caller of the service operation
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 repositoryStatusInfo removeLoCategoryFromLo(String loCategoryId, String loId, ContextInfo contextInfo) throws AlreadyExistsException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, UnsupportedActionException
loCategoryId
- the identifier for the LoCategoryloId
- the identifier for the LocontextInfo
- information containing the principalId and locale information about the caller of the service operation
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 repositoryLoLoRelationInfo getLoLoRelation(String loLoRelationId, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
loLoRelationId
- the identifier for the LoLoRelation to be retrievedcontextInfo
- information containing the principalId and locale information about the caller of the service operation
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 occurredList<LoLoRelationInfo> getLoLoRelationsByIds(List<String> loLoRelationIds, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
loLoRelationIds
- a list of LoLoRelation identifierscontextInfo
- information containing the principalId and locale information about the caller of the service operation
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 occurredList<String> getLoLoRelationIdsByType(String loLoRelationTypeKey, ContextInfo contextInfo) throws InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
loLoRelationTypeKey
- an identifier for an LoLoRelation TypecontextInfo
- information containing the principalId and locale information about the caller of the service operation
InvalidParameterException
- contextInfo is not valid
MissingParameterException
- loLoRelationTypeKey or context is missing or null
OperationFailedException
- unable to complete request
PermissionDeniedException
- an authorization failure occurredList<LoLoRelationInfo> getLoLoRelationsByLoId(String loId, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
loId
- an identifier for the LocontextInfo
- information containing the principalId and locale information about the caller of the service operation
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 occurredList<String> searchForLoLoRelationIds(QueryByCriteria criteria, ContextInfo contextInfo) throws InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
criteria
- the search criteriacontextInfo
- information containing the principalId and locale information about the caller of the service operation
InvalidParameterException
- criteria or contextInfo is not valid
MissingParameterException
- criteria or contextInfo is missing or null
OperationFailedException
- unable to complete request
PermissionDeniedException
- an authorization failure occurredList<LoLoRelationInfo> searchForLoLoRelations(QueryByCriteria criteria, ContextInfo contextInfo) throws InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
criteria
- the search criteriacontextInfo
- information containing the principalId and locale information about the caller of the service operation
InvalidParameterException
- criteria or context is not valid
MissingParameterException
- criteria or context is missing or null
OperationFailedException
- unable to complete request
PermissionDeniedException
- an authorization failure occurredList<ValidationResultInfo> validateLoLoRelation(String validationTypeKey, LoLoRelationInfo loLoRelationInfo, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
validationTypeKey
- the identifier for the LoLoRelation Type to be validatedloLoRelationInfo
- the LoLoRelation to be validatedcontextInfo
- information containing the principalId and locale information about the caller of the service operation
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 occurredLoLoRelationInfo createLoLoRelation(String loLoRelationTypeKey, LoLoRelationInfo loLoRelationInfo, ContextInfo contextInfo) throws DataValidationErrorException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, ReadOnlyException
loLoRelationTypeKey
- the identifier for the Type of LoLoRelation to be createdtype
- relatedLoId
- loLoRelationInfo
- the data with which to create the LoLoRelationcontextInfo
- information containing the principalId and locale information about the caller of the service operation
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 onlyLoLoRelationInfo updateLoLoRelation(String loLoRelationId, LoLoRelationInfo loLoRelationInfo, ContextInfo contextInfo) throws DataValidationErrorException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, ReadOnlyException, VersionMismatchException
loLoRelationId
- the identifier for the LoLoRelation to be updatedloLoRelationInfo
- the new data for the LoLoRelationcontextInfo
- information containing the principalId and locale information about the caller of the service operation
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 versionStatusInfo deleteLoLoRelation(String loLoRelationId, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
loLoRelationId
- the identifier for the LoLoRelation to be deletedcontextInfo
- information containing the principalId and locale information about the caller of the service operation
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@Deprecated TypeInfo getLoCategoryType(String loCategoryTypeKey, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException
DoesNotExistException
InvalidParameterException
MissingParameterException
OperationFailedException
@Deprecated List<TypeInfo> getLoCategoryTypes() throws OperationFailedException
OperationFailedException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |