LearningObjectiveService

• getLoRepository
• getLoRepositoriesByKeys
• getLoRepositories
• getLoRepositoryKeysByType
• searchForLoRepositoryKeys
• searchForLoRepositories
• validateLoRepository
• createLoRepository
• updateLoRepository
• deleteLoRepository
• getLo
• getLosByIds
• getLoIdsByType
• getLosByLoRepository
• getLosByLoCategory
• getLosByRelatedLoId
• getRelatedLosByLoId
• searchForLoIds
• searchForLos
• validateLo
• createLo
• updateLo
• deleteLo
• getLoCategory
• getLoCategoriesByIds
• getLoCategoriesByLoRepository
• getLoCategoryIdsByType
• getLoCategoriesByLo
• searchForLoCategoryIds
• searchForLoCategories
• validateLoCategory
• createLoCategory
• updateLoCategory
• deleteLoCategory
• deleteLoCategoryByLo
• addLoCategoryToLo
• removeLoCategoryFromLo
• getLoLoRelation
• getLoLoRelationsByIds
• getLoLoRelationIdsByType
• getLoLoRelationsByLoId
• searchForLoLoRelationIds
• searchForLoLoRelations
• validateLoLoRelation
• createLoLoRelation
• updateLoLoRelation
• deleteLoLoRelation
• getLoTypes
• getLoType
• getLoLoRelationTypes
• getLoLoRelationType
• getAllowedLoLoRelationTypesForLoType
• getLoByIdList
• getLoCategories
• getLoCategoriesForLo
• getLoCategoryType
• getLosByRepository
• getLoCategoryTypes

• LoRepositoryInfo
• ContextInfo
• QueryByCriteria
• ValidationResultInfo
• StatusInfo
• LoInfo
• LoCategoryInfo
• LoLoRelationInfo
• LoTypeInfo
• LoLoRelationTypeInfo
• LoCategoryTypeInfo

Method	getLoRepository
Description	Retrieves a single LoRepository by an LoRepository Key.
Parameters	String	loRepositoryKey	the identifier for the LoRepository to be retrieved
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of the service operation
Return	LoRepositoryInfo		the LoRepository requested
Errors	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

Back to Operations

Method	getLoRepositoriesByKeys
Description	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	StringList	loRepositoryKeys	a list of LoRepository Keys
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of the service operation
Return	LoRepositoryInfoList		a list of LoRepositories
Errors	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

Back to Operations

Method	getLoRepositories
Description	Retrieves a list of LoRepositories.
Parameters	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of the service operation
Return	LoRepositoryInfoList		a list of LoRepositories or an empty list if none found
Errors	InvalidParameterException		contextInfo is not valid
	MissingParameterException		contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	getLoRepositoryKeysByType
Description	Retrieves a list of LoRepository keys by LoRepository Type.
Parameters	String	loRepositoryTypeKey	a unique key for an LoRepository Type
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of the service operation
Return	StringList		a list of LoRepository keys matching loRepositoryTypeKey or an empty list if none found
Errors	InvalidParameterException		contextInfo is not valid
	MissingParameterException		loRepositoryTypeKey or context is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	searchForLoRepositoryKeys
Description	Searches for LoRepositories that meet the given search criteria.
Parameters	QueryByCriteria	criteria	the search criteria
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of the service operation
Return	StringList		a list of LoRepository keys matching the criteria
Errors	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

Back to Operations

Method	searchForLoRepositories
Description	Searches for LoRepositories that meet the given search criteria.
Parameters	QueryByCriteria	criteria	the search criteria
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of the service operation
Return	LoRepositoryInfoList		a list of LoRepositories matching the criteria
Errors	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

Back to Operations

Method	validateLoRepository
Description	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	String	validationTypeKey	the identifier for the validation Type
	String	loRepositoryTypeKey	the identifier for the LoRepository Type
	LoRepositoryInfo	loRepositoryInfo	the LoRepository to be validated
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of the service operation
Return	ValidationResultInfoList		a list of validation results or an empty list if validation succeeded
Errors	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

Back to Operations

Method	createLoRepository
Description	Creates a new LoRepository. The LoRepository Type, and Meta information may not be set in the supplied data object.
Parameters	String	loRepositoryKey	a unique key for the new LoRepository
	String	loRepositoryTypeKey	the identifier for the Type of LoRepository to be created
	LoRepositoryInfo	loRepositoryInfo	the data with which to create the LoRepository
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of the service operation
Return	LoRepositoryInfo		the new LoRepository
Errors	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

Back to Operations

Method	updateLoRepository
Description	Updates an existing LoRepository. The LoRepository Key, Type, and Meta information may not be changed.
Parameters	String	loRepositoryKey	the identifier for the LoRepository to be updated
	LoRepositoryInfo	loRepositoryInfo	the new data for the LoRepository
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of the service operation
Return	LoRepositoryInfo		the updated LoRepository
Errors	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

Back to Operations

Method	deleteLoRepository
Description	Deletes an existing LoRepository.
Parameters	String	loRepositoryKey	the identifier for the LoRepository to be deleted
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of the service operation
Return	StatusInfo		the status of the delete operation. This must always be true.
Errors	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

Back to Operations

Method	getLo
Description	Retrieves a single Lo by an Lo Id.
Parameters	String	loId	the identifier for the Lo to be retrieved
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of the service operation
Return	LoInfo		the Lo requested
Errors	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

Back to Operations

Method	getLosByIds
Description	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	StringList	loIds	a list of Lo identifiers
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of the service operation
Return	LoInfoList		a list of Los
Errors	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

Back to Operations

Method	getLoIdsByType
Description	Retrieves a list of Lo Ids by Lo Type.
Parameters	String	loTypeKey	an identifier for an Lo Type
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of the service operation
Return	StringList		a list of Lo identifiers matching loTypeKey or an empty list if none found
Errors	InvalidParameterException		contextInfo is not valid
	MissingParameterException		loTypeKey or context is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	getLosByLoRepository
Description	Retrieves a list of Los by LoRepository.
Parameters	String	loRepositoryKey	a key for the LoRepository
	String	loTypeKey	the identifier for the Lo Type
	String	loStateKey	the identifier for the Lo State
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of the service operation
Return	LoInfoList		a list of Los for the LoRepository
Errors	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

Back to Operations

Method	getLosByLoCategory
Description	Retrieves a list of Los by LoCategory.
Parameters	String	loCategoryId	an identifier for the LoCategory
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of the service operation
Return	LoInfoList		a list of Los for the LoCategory
Errors	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

Back to Operations

Method	getLosByRelatedLoId
Description	Retrieves a list of Los by related Lo.
Parameters	String	relatedLoId	an identifier for the related Lo
	String	loLoRelationTypeKey	the identifier for the LoLoRelation Type
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of the service operation
Return	LoInfoList		a list of Los for the related Lo
Errors	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

Back to Operations

Method	getRelatedLosByLoId
Description	Retrieves a list of related Los by Lo.
Parameters	String	loId	an identifier for the Lo
	String	loLoRelationTypeKey	the identifier for the LoLoRelation Type
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of the service operation
Return	LoInfoList		a list of related Los for the Lo
Errors	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

Back to Operations

Method	searchForLoIds
Description	Searches for Los that meet the given search criteria.
Parameters	QueryByCriteria	criteria	the search criteria
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of the service operation
Return	StringList		a list of Lo identifiers matching the criteria
Errors	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

Back to Operations

Method	searchForLos
Description	Searches for Los that meet the given search criteria.
Parameters	QueryByCriteria	criteria	the search criteria
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of the service operation
Return	LoInfoList		a list of Los matching the criteria
Errors	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

Back to Operations

Method	validateLo
Description	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	String	validationTypeKey	the identifier for the Lo Type to be validated
	LoInfo	loInfo	the Lo to be validated
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of the service operation
Return	ValidationResultInfoList		a list of validation results or an empty list if validation succeeded
Errors	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

Back to Operations

Method	createLo
Description	Creates a new Lo. The Lo Id, Type, and Meta information may not be set in the supplied data object.
Parameters	String	repositoryId	???
	String	loType	???
	LoInfo	loInfo	the data with which to create the Lo
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of the service operation
Return	LoInfo		the new Lo
Errors	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

Back to Operations

Method	updateLo
Description	Updates an existing Lo. The Lo Id, Type, and Meta information may not be changed.
Parameters	String	loId	the identifier for the Lo to be updated
	LoInfo	loInfo	the new data for the Lo
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of the service operation
Return	LoInfo		the updated Lo
Errors	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

Back to Operations

Method	deleteLo
Description	Deletes an existing Lo.
Parameters	String	loId	the identifier for the Lo to be deleted
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of the service operation
Return	StatusInfo		the status of the delete operation. This must always be true.
Errors	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		???

Back to Operations

Method	getLoCategory
Description	Retrieves a single LoCategory by an LoCategory Id.
Parameters	String	loCategoryId	the identifier for the LoCategory to be retrieved
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of the service operation
Return	LoCategoryInfo		the LoCategory requested
Errors	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

Back to Operations

Method	getLoCategoriesByIds
Description	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	StringList	loCategoryIds	a list of LoCategory identifiers
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of the service operation
Return	LoCategoryInfoList		a list of LoCategories
Errors	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

Back to Operations

Method	getLoCategoriesByLoRepository
Description	Retrieves a list of LoCategories by their associated repository key
Parameters	String	loRepositoryKey	a list of LoCategory identifiers
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of the service operation
Return	LoCategoryInfoList		a list of LoCategories
Errors	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

Back to Operations

Method	getLoCategoryIdsByType
Description	Retrieves a list of LoCategory Ids by LoCategory Type.
Parameters	String	loCategoryTypeKey	an identifier for an LoCategory Type
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of the service operation
Return	StringList		a list of LoCategory identifiers matching loCategoryTypeKey or an empty list if none found
Errors	InvalidParameterException		contextInfo is not valid
	MissingParameterException		loCategoryTypeKey or context is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	getLoCategoriesByLo
Description	Retrieves a list of LoCategories by Lo.
Parameters	String	loId	an identifier for the Lo
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of the service operation
Return	LoCategoryInfoList		a list of LoCategories for the Lo
Errors	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

Back to Operations

Method	searchForLoCategoryIds
Description	Searches for LoCategories that meet the given search criteria.
Parameters	QueryByCriteria	criteria	the search criteria
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of the service operation
Return	StringList		a list of LoCategory identifiers matching the criteria
Errors	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

Back to Operations

Method	searchForLoCategories
Description	Searches for LoCategories that meet the given search criteria.
Parameters	QueryByCriteria	criteria	the search criteria
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of the service operation
Return	LoCategoryInfoList		a list of LoCategories matching the criteria
Errors	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

Back to Operations

Method	validateLoCategory
Description	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	String	validationTypeKey	the identifier for the LoCategory Type to be validated
	LoCategoryInfo	loCategoryInfo	the LoCategory to be validated
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of the service operation
Return	ValidationResultInfoList		a list of validation results or an empty list if validation succeeded
Errors	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

Back to Operations

Method	createLoCategory
Description	Creates a new LoCategory. The LoCategory Id, Type, and Meta information may not be set in the supplied data object.
Parameters	String	loCategoryTypeKey	the identifier for the Type of LoCategory to be created
	LoCategoryInfo	loCategoryInfo	the data with which to create the LoCategory
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of the service operation
Return	LoCategoryInfo		the new LoCategory
Errors	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

Back to Operations

Method	updateLoCategory
Description	Updates an existing LoCategory. The LoCategory Id, Type, and Meta information may not be changed.
Parameters	String	loCategoryId	the identifier for the LoCategory to be updated
	LoCategoryInfo	loCategoryInfo	the new data for the LoCategory
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of the service operation
Return	LoCategoryInfo		the updated LoCategory
Errors	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

Back to Operations

Method	deleteLoCategory
Description	Deletes an existing LoCategory.
Parameters	String	loCategoryId	the identifier for the LoCategory to be deleted
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of the service operation
Return	StatusInfo		the status of the delete operation. This must always be true.
Errors	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		???

Back to Operations

Method	deleteLoCategoryByLo
Description	Deletes existing LoCategories of a Lo.
Parameters	String	loId	the identifier for the Lo for which LoCategories are to be deleted
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of the service operation
Return	StatusInfo		the status of the delete operation. This must always be true.
Errors	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

Back to Operations

Method	addLoCategoryToLo
Description	Adds a LoCategory to a Lo
Parameters	String	loCategoryId	the identifier for the LoCategory
	String	loId	the identifier for the Lo
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of the service operation
Return	StatusInfo		the status of the delete operation. This must always be true.
Errors	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

Back to Operations

Method	removeLoCategoryFromLo
Description	Removes a LoCategory from a Lo
Parameters	String	loCategoryId	the identifier for the LoCategory
	String	loId	the identifier for the Lo
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of the service operation
Return	StatusInfo		the status of the delete operation. This must always be true.
Errors	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

Back to Operations

Method	getLoLoRelation
Description	Retrieves a single LoLoRelation by an LoLoRelation Id.
Parameters	String	loLoRelationId	the identifier for the LoLoRelation to be retrieved
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of the service operation
Return	LoLoRelationInfo		the LoLoRelation requested
Errors	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

Back to Operations

Method	getLoLoRelationsByIds
Description	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	StringList	loLoRelationIds	a list of LoLoRelation identifiers
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of the service operation
Return	LoLoRelationInfoList		a list of LoLoRelations
Errors	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

Back to Operations

Method	getLoLoRelationIdsByType
Description	Retrieves a list of LoLoRelation Ids by LoLoRelation Type.
Parameters	String	loLoRelationTypeKey	an identifier for an LoLoRelation Type
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of the service operation
Return	StringList		a list of LoLoRelation identifiers matching loLoRelationTypeKey or an empty list if none found
Errors	InvalidParameterException		contextInfo is not valid
	MissingParameterException		loLoRelationTypeKey or context is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	getLoLoRelationsByLoId
Description	Retrieves a list of LoLoRelations by Lo.
Parameters	String	loId	an identifier for the Lo
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of the service operation
Return	LoLoRelationInfoList		a list of LoLoRelations for the Lo
Errors	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

Back to Operations

Method	searchForLoLoRelationIds
Description	Searches for LoLoRelations that meet the given search criteria.
Parameters	QueryByCriteria	criteria	the search criteria
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of the service operation
Return	StringList		a list of LoLoRelation identifiers matching the criteria
Errors	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

Back to Operations

Method	searchForLoLoRelations
Description	Searches for LoLoRelations that meet the given search criteria.
Parameters	QueryByCriteria	criteria	the search criteria
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of the service operation
Return	LoLoRelationInfoList		a list of LoLoRelations matching the criteria
Errors	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

Back to Operations

Method	validateLoLoRelation
Description	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	String	validationTypeKey	the identifier for the LoLoRelation Type to be validated
	LoLoRelationInfo	loLoRelationInfo	the LoLoRelation to be validated
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of the service operation
Return	ValidationResultInfoList		a list of validation results or an empty list if validation succeeded
Errors	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

Back to Operations

Method	createLoLoRelation
Description	Creates a new LoLoRelation. The LoLoRelation Id, Type, and Meta information may not be set in the supplied data object.
Parameters	String	loLoRelationTypeKey	the identifier for the Type of LoLoRelation to be created
	LoLoRelationInfo	loLoRelationInfo	the data with which to create the LoLoRelation
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of the service operation
Return	LoLoRelationInfo		the new LoLoRelation
Errors	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

Back to Operations

Method	updateLoLoRelation
Description	Updates an existing LoLoRelation. The LoLoRelation Id, Type, and Meta information may not be changed.
Parameters	String	loLoRelationId	the identifier for the LoLoRelation to be updated
	LoLoRelationInfo	loLoRelationInfo	the new data for the LoLoRelation
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of the service operation
Return	LoLoRelationInfo		the updated LoLoRelation
Errors	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

Back to Operations

Method	deleteLoLoRelation
Description	Deletes an existing LoLoRelation.
Parameters	String	loLoRelationId	the identifier for the LoLoRelation to be deleted
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of the service operation
Return	StatusInfo		the status of the delete operation. This must always be true.
Errors	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

Back to Operations

Method	getLoTypes
Description	This method ... ============== Deprecated ===============
Parameters	ContextInfo	contextInfo	???
Return	LoTypeInfoList		???
Errors	OperationFailedException		???

Back to Operations

Method	getLoType
Description	This method ... ============== Deprecated ===============
Parameters	String	loTypeKey	???
	ContextInfo	contextInfo	???
Return	LoTypeInfo		???
Errors	DoesNotExistException		???
	InvalidParameterException		???
	MissingParameterException		???
	OperationFailedException		???

Back to Operations

Method	getLoLoRelationTypes
Description	This method ... ============== Deprecated ===============
Parameters	ContextInfo	contextInfo	???
Return	LoLoRelationTypeInfoList		???
Errors	OperationFailedException		???

Back to Operations

Method	getLoLoRelationType
Description	This method ... ============== Deprecated ===============
Parameters	String	loLoRelationTypeKey	???
	ContextInfo	contextInfo	???
Return	LoLoRelationTypeInfo		???
Errors	OperationFailedException		???
	MissingParameterException		???
	DoesNotExistException		???

Back to Operations

Method	getAllowedLoLoRelationTypesForLoType
Description	This method ... ============== Deprecated ===============
Parameters	String	loTypeKey	???
	String	relatedLoTypeKey	???
	ContextInfo	contextInfo	???
Return	StringList		???
Errors	DoesNotExistException		???
	InvalidParameterException		???
	MissingParameterException		???
	OperationFailedException		???

Back to Operations

Method	getLoByIdList
Description	This method ... ============== Deprecated ===============
Parameters	StringList	loIds	???
	ContextInfo	contextInfo	???
Return	LoInfoList		???
Errors	InvalidParameterException		???
	MissingParameterException		???
	OperationFailedException		???

Back to Operations

Method	getLoCategories
Description	This method ... ============== Deprecated ===============
Parameters	String	loRepositoryKey	???
	ContextInfo	contextInfo	???
Return	LoCategoryInfoList		???
Errors	DoesNotExistException		???
	InvalidParameterException		???
	MissingParameterException		???
	OperationFailedException		???

Back to Operations

Method	getLoCategoriesForLo
Description	This method ... ============== Deprecated ===============
Parameters	String	loId	???
	ContextInfo	contextInfo	???
Return	LoCategoryInfoList		???
Errors	DoesNotExistException		???
	InvalidParameterException		???
	MissingParameterException		???
	OperationFailedException		???

Back to Operations

Method	getLoCategoryType
Description	This method ... ============== Deprecated ===============
Parameters	String	loCategoryTypeKey	???
	ContextInfo	contextInfo	???
Return	LoCategoryTypeInfo		???
Errors	DoesNotExistException		???
	InvalidParameterException		???
	MissingParameterException		???
	OperationFailedException		???

Back to Operations

Method	getLosByRepository
Description	This method ... ============== Deprecated ===============
Parameters	String	loRepositoryKey	???
	String	loTypeKey	???
	String	loStateKey	???
Return	LoInfoList		???
Errors	InvalidParameterException		???
	MissingParameterException		???
	OperationFailedException		???

Back to Operations

Method	getLoCategoryTypes
Description	This method ... ============== Deprecated ===============
Parameters	None	None	No Parameters
Return	LoCategoryTypeInfoList		???
Errors	OperationFailedException		???

Back to Operations