org.kuali.student.enrollment.lui.service
Interface LuiService

All Known Implementing Classes:

LuiServiceDecorator, LuiServiceImpl, LuiServiceValidationDecorator

public interface LuiService

Learning Unit Instance (LUI) Service Manages the creation of Instances of the canonical Learning unit. An instance is associated with a particular time period during which is is offered. This includes course and section offerings as well as program offerings

Version:

0.0.7

Author:

tom

Method Summary

LuiInfo	createLui(String cluId, String atpId, String luiTypeKey, LuiInfo luiInfo, ContextInfo contextInfo) Creates a new LUI.
LuiCapacityInfo	createLuiCapacity(String luiCapacityTypeKey, LuiCapacityInfo luiCapacityInfo, ContextInfo contextInfo) Creates a new LuiCapacity.
LuiLuiRelationInfo	createLuiLuiRelation(String luiId, String relatedLuiId, String luiLuiRelationTypeKey, LuiLuiRelationInfo luiLuiRelationInfo, ContextInfo contextInfo) Create new LuiLuiRelation.
LuiSetInfo	createLuiSet(String luiSetTypeKey, LuiSetInfo luiSetInfo, ContextInfo contextInfo) Creates a Lui set.
StatusInfo	deleteLui(String luiId, ContextInfo contextInfo) Deletes an existing Lui.
StatusInfo	deleteLuiCapacity(String luiCapacityId, ContextInfo contextInfo) Deletes an existing LuiCapacity.
StatusInfo	deleteLuiLuiRelation(String luiLuiRelationId, ContextInfo contextInfo) Deletes an existing LuiLuiRelation.
StatusInfo	deleteLuiSet(String luiSetId, ContextInfo contextInfo) Delete a Lui set
LuiInfo	getLui(String luiId, ContextInfo contextInfo) Retrieves a single Lui by a Lui Id.
List<LuiCapacityInfo>	getLuiCapacitiesByIds(List<String> luiCapacityIds, ContextInfo contextInfo) Retrieves a list of LuiCapacity from a list of LuiCapacity Ids.
List<LuiCapacityInfo>	getLuiCapacitiesByLui(String luiId, ContextInfo contextInfo) Retrieves LuiCapacities associated with a Lui.
LuiCapacityInfo	getLuiCapacity(String luiCapacityId, ContextInfo contextInfo) Retrieves a single LuiCapacity by a LuiCapacity Id.
List<String>	getLuiCapacityIdsByType(String luiCapacityTypeKey, ContextInfo contextInfo) Retrieves a list of LuiCapacity Ids by LuiCapacity Type.
List<String>	getLuiIdsByAtpAndClu(String cluId, String atpId, ContextInfo contextInfo) Retrieves the list of Lui Ids for the specified Clu and Time period.
List<String>	getLuiIdsByAtpAndType(String atpId, String luiTypeKey, ContextInfo contextInfo) Retrieves the list of Lui Ids for the specified atp and Lui Type.
List<String>	getLuiIdsByClu(String cluId, ContextInfo contextInfo) Retrieves a list of Lui Ids by Clu.
List<String>	getLuiIdsByLuiAndRelationType(String luiId, String luiLuiRelationTypeKey, ContextInfo contextInfo) TODO ??? Retrieves the list of related LUI Ids for the specified LUI Id and LU to LU relation type.
List<String>	getLuiIdsByRelatedLuiAndRelationType(String relatedLuiId, String luiLuiRelationTypeKey, ContextInfo contextInfo) Retrieves a list of LUI Ids for the specified related LUI Id and LU to LU relation type (getRelatedLuiIdsByLuiId from the other direction).
List<String>	getLuiIdsByType(String luiTypeKey, ContextInfo contextInfo) Retrieves a list of Lui Ids by Lui Type.
List<String>	getLuiIdsFromLuiSet(String luiSetId, ContextInfo contextInfo) Retrieves the list of Lui Identifiers within a Lui Set.
LuiLuiRelationInfo	getLuiLuiRelation(String luiLuiRelationId, ContextInfo contextInfo) Retrieves a single LuiLuiRelation by a LuiLuiRelation Id.
List<String>	getLuiLuiRelationIdsByType(String luiLuiRelationTypeKey, ContextInfo contextInfo) Retrieves a list of LuiLuiRelation Ids by a LuiLuiRelation Type.
List<LuiLuiRelationInfo>	getLuiLuiRelationsByIds(List<String> luiLuiRelationIds, ContextInfo contextInfo) Retrieves a list of LuiLuiRelations from a list of LuiLuiRelation Ids.
List<LuiLuiRelationInfo>	getLuiLuiRelationsByLui(String luiId, ContextInfo contextInfo) Retrieves all LuiLuiRelations to the given Lui.
List<LuiLuiRelationInfo>	getLuiLuiRelationsByLuiAndRelatedLui(String luiId, String relatedLuiId, ContextInfo contextInfo) Retrieves all LuiLuiRelations between the given Luis.
List<LuiInfo>	getLuiLuiRelationsByLuiAndRelatedLuiType(String luiId, String relatedLuiTypeKey, ContextInfo contextInfo) Retrieves all LuiLuiRelations between a Lui and Luis of the given Lui Type.
List<LuiInfo>	getLuisByAtpAndClu(String cluId, String atpId, ContextInfo contextInfo) Retrieves the list of Luis for the specified Clu and Atp.
List<LuiInfo>	getLuisByIds(List<String> luiIds, ContextInfo contextInfo) Retrieves a list of Luis from a list of Lui Ids.
List<LuiInfo>	getLuisByRelatedLuiAndRelationType(String relatedLuiId, String luiLuiRelationTypeKey, ContextInfo contextInfo) TODO Retrieves the list of LUI information for the LUIs related to the specified LUI Id with a certain LU to LU relation type.
LuiSetInfo	getLuiSet(String luiSetId, ContextInfo contextInfo) Retrieves information on a Lui set.
List<LuiSetInfo>	getLuiSetsByIds(List<String> luiSetIds, ContextInfo contextInfo) Retrieve information on Lui sets from a list of LuiSet Ids.
TypeInfo	getLuiSetType(String luiSetTypeKey, ContextInfo contextInfo) Retrieves information about a specified Lui set type
List<TypeInfo>	getLuiSetTypes(ContextInfo contextInfo) Retrieves the list of Lui set types known by the service
List<LuiInfo>	getLuisFromLuiSet(String luiSetId, ContextInfo contextInfo) Retrieves the list of Luis in a Lui set.
List<LuiInfo>	getRelatedLuisByLuiAndRelationType(String luiId, String luiLuiRelationTypeKey, ContextInfo contextInfo) TODO ??? Retrieves the list of related LUI information for the specified LUI Id and LU to LU relation type (getLuisByRelatedLuiAndRelationType from the other direction).
Boolean	isLuiInLuiSet(String luiId, String luiSetId, ContextInfo contextInfo) Checks if a Lui is a member of a Lui set.
List<LuiCapacityInfo>	searchForLuiCapacities(QueryByCriteria criteria, ContextInfo contextInfo) Searches for LuiCapacities that meet the search criteria and returns a list of LuiCapacities that meet the criteria.
List<String>	searchForLuiCapacityIds(QueryByCriteria criteria, ContextInfo contextInfo) Searches for LuiCapacities that meet the search criteria and returns a list of LuiCapacity identifiers that meet the criteria.
List<String>	searchForLuiIds(QueryByCriteria criteria, ContextInfo contextInfo) Searches for Luis that meet the given search criteria and returns a list of Lui identifiers that meet the criteria.
List<String>	searchForLuiLuiRelationIds(QueryByCriteria criteria, ContextInfo contextInfo) Searches for LuiLuiRelations that meet the search criteria and returns a list of LuiLuiRelation identifiers that meet the criteria.
List<LuiLuiRelationInfo>	searchForLuiLuiRelations(QueryByCriteria criteria, ContextInfo contextInfo) Searches for LuiLuiRelations that meet the search criteria and returns a list of LuiLuiRelations that meet the criteria.
List<LuiInfo>	searchForLuis(QueryByCriteria criteria, ContextInfo contextInfo) Searches for Luis that meet the given search criteria.
LuiInfo	updateLui(String luiId, LuiInfo luiInfo, ContextInfo contextInfo) Updates an existing Lui.
LuiCapacityInfo	updateLuiCapacity(String luiCapacityId, LuiCapacityInfo luiCapacityInfo, ContextInfo contextInfo) Updates an existing LuiCapacity.
LuiLuiRelationInfo	updateLuiLuiRelation(String luiLuiRelationId, LuiLuiRelationInfo luiLuiRelationInfo, ContextInfo contextInfo) Updates an existing LuiLuiRelation.
LuiSetInfo	updateLuiSet(String luiSetId, LuiSetInfo luiSetInfo, ContextInfo contextInfo) Update the information for a Lui set
List<ValidationResultInfo>	validateLui(String validationTypeKey, String cluId, String atpId, String luiTypeKey, LuiInfo luiInfo, ContextInfo contextInfo) Validates a Lui.
List<ValidationResultInfo>	validateLuiCapacity(String validationTypeKey, String luiCapacityTypeKey, LuiCapacityInfo luiCapacityInfo, ContextInfo contextInfo) Validates a LuiCapacity.
List<ValidationResultInfo>	validateLuiLuiRelation(String validationTypeKey, String luiId, String relatedLuiId, String luiLuiRelationTypeKey, LuiLuiRelationInfo luiLuiRelationInfo, ContextInfo contextInfo) Validates a LuiLuiRelations.
List<ValidationResultInfo>	validateLuiSet(String validationTypeKey, String luiSetTypeKey, LuiSetInfo LuiSetInfo, ContextInfo contextInfo) Validates information about a Lui set.

Method Detail

getLui

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

Retrieves a single Lui by a Lui Id.

Parameters:

luiId - the identifier for the Lui to be retrieved

contextInfo - information containing the principalId and locale information about the caller of service operation

Returns:

the Lui requested

Throws:

DoesNotExistException - luiId not found

InvalidParameterException - contextInfo is not valid

MissingParameterException - luiId or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

getLuisByIds

List<LuiInfo> getLuisByIds(List<String> luiIds,
                           ContextInfo contextInfo)
                           throws DoesNotExistException,
                                  InvalidParameterException,
                                  MissingParameterException,
                                  OperationFailedException,
                                  PermissionDeniedException

Retrieves a list of Luis from a list of Lui Ids. The returned list may be in any order and if duplicates Ids are supplied, a unique set may or may not be returned.

Parameters:

luiIds - a list of Lui identifiers

contextInfo - information containing the principalId and locale information about the caller of service operation

Returns:

a list of Luis

Throws:

DoesNotExistException - a luiId in the list was not found

InvalidParameterException - contextInfo is not valid

MissingParameterException - luiIds, an Id in luiIds, or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

getLuiIdsByType

List<String> getLuiIdsByType(String luiTypeKey,
                             ContextInfo contextInfo)
                             throws InvalidParameterException,
                                    MissingParameterException,
                                    OperationFailedException,
                                    PermissionDeniedException

Retrieves a list of Lui Ids by Lui Type.

Parameters:

luiTypeKey - an identifier for a Lui Type

contextInfo - information containing the principalId and locale information about the caller of service operation

Returns:

a list of Lui identifiers matching luiTypeKey or an empty list if none found

Throws:

InvalidParameterException - contextInfo is not valid

MissingParameterException - luiTypeKey or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

getLuiIdsByClu

List<String> getLuiIdsByClu(String cluId,
                            ContextInfo contextInfo)
                            throws InvalidParameterException,
                                   MissingParameterException,
                                   OperationFailedException,
                                   PermissionDeniedException

Retrieves a list of Lui Ids by Clu. (the pattern says this should return the objects).

Parameters:

cluId - an identifier for the Clu

contextInfo - information containing the principalId and locale information about the caller of service operation

Returns:

list of Lui Ids for the Clu

Throws:

InvalidParameterException - contextInfo is not valid

MissingParameterException - cluId or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

getLuiIdsByAtpAndType

List<String> getLuiIdsByAtpAndType(String atpId,
                                   String luiTypeKey,
                                   ContextInfo contextInfo)
                                   throws InvalidParameterException,
                                          MissingParameterException,
                                          OperationFailedException,
                                          PermissionDeniedException

Retrieves the list of Lui Ids for the specified atp and Lui Type.

Parameters:

atpId - an identifier for the Atp

luiTypeKey - an identifier for the Lui Type

contextInfo - information containing the principalId and locale information about the caller of service operation

Returns:

a list of identifiers of Luis offered in the given Atp of the specified luiType

Throws:

InvalidParameterException - contextInfo is not valid

MissingParameterException - atpId, luiTypeKey, or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

getLuiIdsByAtpAndClu

List<String> getLuiIdsByAtpAndClu(String cluId,
                                  String atpId,
                                  ContextInfo contextInfo)
                                  throws InvalidParameterException,
                                         MissingParameterException,
                                         OperationFailedException,
                                         PermissionDeniedException

Retrieves the list of Lui Ids for the specified Clu and Time period.

Parameters:

cluId - an identifier for the Clu

atpId - an identifier for the Atp

contextInfo - information containing the principalId and locale information about the caller of service operation

Returns:

a list of identifiers of Luis offered in atpId and related to cluId

Throws:

InvalidParameterException - contextInfo is not valid

MissingParameterException - cluId, atpId, or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

getLuisByAtpAndClu

List<LuiInfo> getLuisByAtpAndClu(String cluId,
                                 String atpId,
                                 ContextInfo contextInfo)
                                 throws InvalidParameterException,
                                        MissingParameterException,
                                        OperationFailedException,
                                        PermissionDeniedException

Retrieves the list of Luis for the specified Clu and Atp.

Parameters:

cluId - an identifier for the Clu

atpId - an identifier for the Atp

contextInfo - information containing the principalId and locale information about the caller of service operation

Returns:

a list of Luis offered in atpId and related to cluId

Throws:

InvalidParameterException - contextInfo is not valid

MissingParameterException - cluId, atpId, or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

searchForLuiIds

List<String> searchForLuiIds(QueryByCriteria criteria,
                             ContextInfo contextInfo)
                             throws InvalidParameterException,
                                    MissingParameterException,
                                    OperationFailedException,
                                    PermissionDeniedException

Searches for Luis that meet the given search criteria and returns a list of Lui identifiers that meet the criteria.

Parameters:

criteria - the search criteria

contextInfo - information containing the principalId and locale information about the caller of service operation

Returns:

a list of Lui Ids 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

searchForLuis

List<LuiInfo> searchForLuis(QueryByCriteria criteria,
                            ContextInfo contextInfo)
                            throws InvalidParameterException,
                                   MissingParameterException,
                                   OperationFailedException,
                                   PermissionDeniedException

Searches for Luis that meet the given search criteria.

Parameters:

criteria - the search criteria

contextInfo - information containing the principalId and locale information about the caller of service operation

Returns:

a list of Luis 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

validateLui

List<ValidationResultInfo> validateLui(String validationTypeKey,
                                       String cluId,
                                       String atpId,
                                       String luiTypeKey,
                                       LuiInfo luiInfo,
                                       ContextInfo contextInfo)
                                       throws DoesNotExistException,
                                              InvalidParameterException,
                                              MissingParameterException,
                                              OperationFailedException,
                                              PermissionDeniedException

Validates a Lui. Depending on the value of validationType, this validation could be limited to tests on just the current Lui and its directly contained sub-objects or expanded to perform all tests related to this Lui. If an identifier is present for the Lui (and/or one of its contained sub-objects) and a record is found for that identifier, the validation checks if the Lui can be updated to the new values. If an identifier is not present or a record does not exist, the validation checks if the object with the given data can be created.

Parameters:

validationTypeKey - the identifier for the validation Type

cluId - the identifier for the Clu to which the Lui is attached

atpId - the identifier for the Atp to which the Lui if offered

luiTypeKey - the identifier for the Lui Type

luiInfo - the object to be validated

contextInfo - information containing the principalId and locale information about the caller of service operation

Returns:

a list of validation results or an empty list if validation succeeded

Throws:

DoesNotExistException - validationTypeKey, cluId, atpId, or luiTypeKey is not found

InvalidParameterException - luiInfo or contextInfo is not valid

MissingParameterException - validationTypeKey, cluId, atpId, luiTypeKey, luiInfo, or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

createLui

LuiInfo createLui(String cluId,
                  String atpId,
                  String luiTypeKey,
                  LuiInfo luiInfo,
                  ContextInfo contextInfo)
                  throws DataValidationErrorException,
                         DoesNotExistException,
                         InvalidParameterException,
                         MissingParameterException,
                         OperationFailedException,
                         PermissionDeniedException,
                         ReadOnlyException

Creates a new LUI. The Lui Id, Type, Clu Id, Atp Id, and Meta information may not be set in the supplied data.

Parameters:

cluId - the identifier for the Clu

atpId - the identifier for the Atp

luiTypeKey - an identifier for the Type of the new Lui

luiInfo - the data with which to create the Lui

contextInfo - information containing the principalId and locale information about the caller of service operation

Returns:

the new Lui

Throws:

DataValidationErrorException - supplied data is invalid

DoesNotExistException - cluId, atpId, or luiTypeKey is not found

InvalidParameterException - luiInfo or contextInfo is not valid

MissingParameterException - cluId, atpId, luiTypeKey, luiInfo, 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

updateLui

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

Updates an existing Lui. The Lui Id, Type, Clu Id, Atp Id, and Meta information may not be changed.

Parameters:

luiId - the identifier for the LUI to be updated

luiInfo - the new data for the Lui

contextInfo - information containing the principalId and locale information about the caller of service operation

Returns:

the updated Lui

Throws:

DataValidationErrorException - supplied data is invalid

DoesNotExistException - luiId not found

InvalidParameterException - luiInfo or contextInfo is not valid

MissingParameterException - luiId, luiInfo, 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 - optimistic locking failure or the action was attempted on an out of date version

deleteLui

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

Deletes an existing Lui.

Parameters:

luiId - the identifier for the LUI to be deleted

contextInfo - information containing the principalId and locale information about the caller of service operation

Returns:

the status of the delete operation. This must always be true.

Throws:

DependentObjectsExistException - the delete operation would leave orphaned objects or violate integrity constraints

DoesNotExistException - luiId not found

InvalidParameterException - contextInfo is not valid

MissingParameterException - luiId or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

getLuiLuiRelation

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

Retrieves a single LuiLuiRelation by a LuiLuiRelation Id.

Parameters:

luiLuiRelationId - a unique identifier for the LuiLuiRelation to be retrieved

contextInfo - information containing the principalId and locale information about the caller of service operation

Returns:

the LuiLuiRelation requested

Throws:

DoesNotExistException - luiLuiRelationId is not found

InvalidParameterException - contextInfo is not valid

MissingParameterException - luiLuiRetaionId or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

getLuiLuiRelationsByIds

List<LuiLuiRelationInfo> getLuiLuiRelationsByIds(List<String> luiLuiRelationIds,
                                                 ContextInfo contextInfo)
                                                 throws DoesNotExistException,
                                                        InvalidParameterException,
                                                        MissingParameterException,
                                                        OperationFailedException,
                                                        PermissionDeniedException

Retrieves a list of LuiLuiRelations from a list of LuiLuiRelation Ids. The returned list may be in any order and if duplicates Ids are supplied, a unique set may or may not be returned.

Parameters:

luiLuiRelationIds - a list of LuiLuiRelation identifiers

contextInfo - Context information containing the principalId and locale information about the caller of service operation

Returns:

information about a list of LuiLuiRelations

Throws:

DoesNotExistException - a luiLuiRelationId in the list was not found

InvalidParameterException - contextInfo is not valid

MissingParameterException - luiLuiRelationIds, a luiLuiRelationId in luiLuiRelationIds, or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

getLuiLuiRelationIdsByType

List<String> getLuiLuiRelationIdsByType(String luiLuiRelationTypeKey,
                                        ContextInfo contextInfo)
                                        throws InvalidParameterException,
                                               MissingParameterException,
                                               OperationFailedException,
                                               PermissionDeniedException

Retrieves a list of LuiLuiRelation Ids by a LuiLuiRelation Type.

Parameters:

luiLuiRelationTypeKey - an identifier for a LuiLuiRelation Type

contextInfo - information containing the principalId and locale information about the caller of service operation

Returns:

a list of LuiLuiRelation identifiers

Throws:

InvalidParameterException - contextInfo is not valid

MissingParameterException - luiLuiRelationTypeKey or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

getLuiLuiRelationsByLui

List<LuiLuiRelationInfo> getLuiLuiRelationsByLui(String luiId,
                                                 ContextInfo contextInfo)
                                                 throws InvalidParameterException,
                                                        MissingParameterException,
                                                        OperationFailedException,
                                                        PermissionDeniedException

Retrieves all LuiLuiRelations to the given Lui.

Parameters:

luiId - a unique identifier of the LUI

contextInfo - information containing the principalId and locale information about the caller of service operation

Returns:

the LuiLuiRelations to the Lui

Throws:

InvalidParameterException - contextInfo is not valid

MissingParameterException - luiId or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

getLuiLuiRelationsByLuiAndRelatedLui

List<LuiLuiRelationInfo> getLuiLuiRelationsByLuiAndRelatedLui(String luiId,
                                                              String relatedLuiId,
                                                              ContextInfo contextInfo)
                                                              throws InvalidParameterException,
                                                                     MissingParameterException,
                                                                     OperationFailedException,
                                                                     PermissionDeniedException

Retrieves all LuiLuiRelations between the given Luis.

Parameters:

luiId - a unique identifier of the LUI

relatedLuiId - a unique identifier of another LUI

contextInfo - information containing the principalId and locale information about the caller of service operation

Returns:

the LuiLuiRelations between the given Luis

Throws:

InvalidParameterException - contextInfo is not valid

MissingParameterException - luiId, relatedLuiId, or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

getLuiIdsByRelatedLuiAndRelationType

List<String> getLuiIdsByRelatedLuiAndRelationType(String relatedLuiId,
                                                  String luiLuiRelationTypeKey,
                                                  ContextInfo contextInfo)
                                                  throws InvalidParameterException,
                                                         MissingParameterException,
                                                         OperationFailedException,
                                                         PermissionDeniedException

Retrieves a list of LUI Ids for the specified related LUI Id and LU to LU relation type (getRelatedLuiIdsByLuiId from the other direction). (??? this method seems unnecessary)

Parameters:

relatedLuiId - identifier of the LUI

luiLuiRelationTypeKey - the LU to LU relation type

contextInfo - Context information containing the principalId and locale information about the caller of service operation

Returns:

list of LUI identifiers, empty list of none found

Throws:

InvalidParameterException - invalid parameter

MissingParameterException - missing parameter

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

getLuisByRelatedLuiAndRelationType

List<LuiInfo> getLuisByRelatedLuiAndRelationType(String relatedLuiId,
                                                 String luiLuiRelationTypeKey,
                                                 ContextInfo contextInfo)
                                                 throws InvalidParameterException,
                                                        MissingParameterException,
                                                        OperationFailedException,
                                                        PermissionDeniedException

TODO Retrieves the list of LUI information for the LUIs related to the specified LUI Id with a certain LU to LU relation type. (getRelatedLuisByLuiId from the other direction)

Parameters:

relatedLuiId - identifier of the LUI

luiLuiRelationTypeKey - the LU to LU relation type

contextInfo - Context information containing the principalId and locale information about the caller of service operation

Returns:

list of LUI information, empty list if none

Throws:

InvalidParameterException - invalid parameter

MissingParameterException - missing paremeter

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

getLuiIdsByLuiAndRelationType

List<String> getLuiIdsByLuiAndRelationType(String luiId,
                                           String luiLuiRelationTypeKey,
                                           ContextInfo contextInfo)
                                           throws InvalidParameterException,
                                                  MissingParameterException,
                                                  OperationFailedException,
                                                  PermissionDeniedException

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

Parameters:

luiId - identifier of the LUI

luiLuiRelationTypeKey - the LU to LU relation type

contextInfo - Context information containing the principalId and locale information about the caller of service operation

Returns:

list of LUI identifier, empty list if none found

Throws:

InvalidParameterException - invalid parameter

MissingParameterException - missing parameter

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

getRelatedLuisByLuiAndRelationType

List<LuiInfo> getRelatedLuisByLuiAndRelationType(String luiId,
                                                 String luiLuiRelationTypeKey,
                                                 ContextInfo contextInfo)
                                                 throws InvalidParameterException,
                                                        MissingParameterException,
                                                        OperationFailedException,
                                                        PermissionDeniedException

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

Parameters:

luiId - identifier of the LUI

luiLuiRelationTypeKey - the LU to LU relation type

contextInfo - Context information containing the principalId and locale information about the caller of service operation

Returns:

list of LUI information, empty list if none found

Throws:

InvalidParameterException - invalid luiId, luiLuiRelationTypeKey

MissingParameterException - missing luiId, luiLuiRelationTypeKey

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

getLuiLuiRelationsByLuiAndRelatedLuiType

List<LuiInfo> getLuiLuiRelationsByLuiAndRelatedLuiType(String luiId,
                                                       String relatedLuiTypeKey,
                                                       ContextInfo contextInfo)
                                                       throws InvalidParameterException,
                                                              MissingParameterException,
                                                              OperationFailedException,
                                                              PermissionDeniedException

Retrieves all LuiLuiRelations between a Lui and Luis of the given Lui Type.

Parameters:

luiId - a unique identifier for the Lui

relatedLuiTypeKey - a unique identifier for a Lui Type

contextInfo - information containing the principalId and locale information about the caller of service operation

Returns:

a list of LuiLuiRelations between luiId and Luis of relatedLuiTypeKey

Throws:

InvalidParameterException - contextInfo is not valid

MissingParameterException - luiId, relatedLuiTypeKey, or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

searchForLuiLuiRelationIds

List<String> searchForLuiLuiRelationIds(QueryByCriteria criteria,
                                        ContextInfo contextInfo)
                                        throws InvalidParameterException,
                                               MissingParameterException,
                                               OperationFailedException,
                                               PermissionDeniedException

Searches for LuiLuiRelations that meet the search criteria and returns a list of LuiLuiRelation identifiers that meet the criteria.

Parameters:

criteria - the search criteria

contextInfo - information containing the principalId and locale information about the caller of service operation

Returns:

list of LuiLuiRelationIds

Throws:

InvalidParameterException - criteria or contextInfo is not valid

MissingParameterException - criteria or contextInfo is missing os null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

searchForLuiLuiRelations

List<LuiLuiRelationInfo> searchForLuiLuiRelations(QueryByCriteria criteria,
                                                  ContextInfo contextInfo)
                                                  throws InvalidParameterException,
                                                         MissingParameterException,
                                                         OperationFailedException,
                                                         PermissionDeniedException

Searches for LuiLuiRelations that meet the search criteria and returns a list of LuiLuiRelations that meet the criteria.

Parameters:

criteria - the search criteria

contextInfo - information containing the principalId and locale information about the caller of service operation

Returns:

list of LuiLuiRelations

Throws:

InvalidParameterException - criteria or contextInfo is not valid

MissingParameterException - criteria or contextInfo is missing os null

PermissionDeniedException - an authorization failure occurred

OperationFailedException

validateLuiLuiRelation

List<ValidationResultInfo> validateLuiLuiRelation(String validationTypeKey,
                                                  String luiId,
                                                  String relatedLuiId,
                                                  String luiLuiRelationTypeKey,
                                                  LuiLuiRelationInfo luiLuiRelationInfo,
                                                  ContextInfo contextInfo)
                                                  throws DoesNotExistException,
                                                         InvalidParameterException,
                                                         MissingParameterException,
                                                         OperationFailedException,
                                                         PermissionDeniedException

Validates a LuiLuiRelations. Depending on the value of validationType, this validation could be limited to tests on just the current LuiLuiRelation and its directly contained sub-objects or expanded to perform all tests related to this LuiLuiRelation. If an identifier is present for the LuiLuiRelation (and/or one of its contained sub-objects) and a record is found for that identifier, the validation checks if the LuiLuiRelation can be updated to the new values. If an identifier is not present or a record does not exist, the validation checks if the object with the given data can be created.

Parameters:

validationTypeKey - the identifier for the validation Type

luiId - the identifier for the Lui

relatedLuiId - the identifier for the related Lui

luiLuiRelationTypeKey - the identifier for LuiLuiRelation Type

luiLuiRelationInfo - the LuiLuiRelation to ve validated

contextInfo - information containing the principalId and locale information about the caller of service operation

Returns:

a list of validation results or an empty list if validation succeeded

Throws:

DoesNotExistException - validationTypeKey, luiId, relatedLuiId, or luiLuiRelationTypeKey is not found

InvalidParameterException - luiLuiRelationInfo or contextInfo is missing or null

MissingParameterException - validationTypeKey, luiId, relatedLuiId, luiLuiRelationTypeKey, luiLuiRelationInfo, or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

createLuiLuiRelation

LuiLuiRelationInfo createLuiLuiRelation(String luiId,
                                        String relatedLuiId,
                                        String luiLuiRelationTypeKey,
                                        LuiLuiRelationInfo luiLuiRelationInfo,
                                        ContextInfo contextInfo)
                                        throws CircularRelationshipException,
                                               DataValidationErrorException,
                                               DoesNotExistException,
                                               InvalidParameterException,
                                               MissingParameterException,
                                               OperationFailedException,
                                               PermissionDeniedException,
                                               ReadOnlyException

Create new LuiLuiRelation. The LuiLuiRelation Id, Type, luiId, relatedLuiId, and Meta information may not be set in the supplied data.

Parameters:

luiId - identifier of the first LUI in the relationship

relatedLuiId - identifier of the second LUI in the relationship to be related

luiLuiRelationTypeKey - a unique key fo rthe Type or new LuiLuiRelation

luiLuiRelationInfo - the data with which to create the LuiLuiRelation

contextInfo - information containing the principalId and locale information about the caller of service operation

Returns:

the new LuiLuiRelation

Throws:

CircularRelationshipException - luiId equals relatedLuiId (why is this a contract failure?)

DataValidationErrorException - supplied data is invalid

DoesNotExistException - luiId, relatedLuiId, or luiLuiRelationTypeKey is not found

InvalidParameterException - luiLuiRelationInfo ro contextInfo is not valid

MissingParameterException - luiId, relatedLuiId, luiLuiRelationTypeKey, luiLuiRelationInfo, 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

updateLuiLuiRelation

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

Updates an existing LuiLuiRelation. The LuiLuiRelation Id, luiId, relatedLuiId, and Meta information may not be changed.

Parameters:

luiLuiRelationId - the identifier for the LuiLuiRelation to be updated

luiLuiRelationInfo - the new data for the LuiLuiRelation

contextInfo - information containing the principalId and locale information about the caller of service operation

Returns:

the updated LuiLuiRelation

Throws:

DataValidationErrorException - supplied data is invalid

DoesNotExistException - luiLuiRelationId is not found

InvalidParameterException - luiLuiRelationInfo or contextInfo is not valid

MissingParameterException - luiLuiRelationId, luiLuiRelationInfo, 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 - optimistic locking failure or the action was attempted on an out of date version

deleteLuiLuiRelation

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

Deletes an existing LuiLuiRelation.

Parameters:

luiLuiRelationId - identifier or the LuiLuiRelation to be deleted

contextInfo - information containing the principalId and locale information about the caller of service operation

Returns:

the status of the delete operation. This must always be true.

Throws:

DoesNotExistException - luiLuiRelationId not found

InvalidParameterException - contextInfo is not valid

MissingParameterException - luiLuiRelationId or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

getLuiCapacity

LuiCapacityInfo getLuiCapacity(String luiCapacityId,
                               ContextInfo contextInfo)
                               throws DoesNotExistException,
                                      InvalidParameterException,
                                      MissingParameterException,
                                      OperationFailedException,
                                      PermissionDeniedException

Retrieves a single LuiCapacity by a LuiCapacity Id.

Parameters:

luiCapacityId - the identifier for the LuiCapacity to be retrieved

contextInfo - information containing the principalId and locale information about the caller of service operation

Returns:

the LuiCapacity requested

Throws:

DoesNotExistException - luiCapacityId not found

InvalidParameterException - contextInfo is not valid

MissingParameterException - luiCapacityId or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

getLuiCapacitiesByIds

List<LuiCapacityInfo> getLuiCapacitiesByIds(List<String> luiCapacityIds,
                                            ContextInfo contextInfo)
                                            throws DoesNotExistException,
                                                   InvalidParameterException,
                                                   MissingParameterException,
                                                   OperationFailedException,
                                                   PermissionDeniedException

Retrieves a list of LuiCapacity from a list of LuiCapacity 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:

luiCapacityIds - a list of LuiCapacity identifiers

contextInfo - information containing the principalId and locale information about the caller of service operation

Returns:

a list of LuiCapacities

Throws:

DoesNotExistException - a luiCapacityId in the list was not found

InvalidParameterException - contextInfo is not valid

MissingParameterException - luiCapacityIds, an Id in luiCapacityIds, or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

getLuiCapacityIdsByType

List<String> getLuiCapacityIdsByType(String luiCapacityTypeKey,
                                     ContextInfo contextInfo)
                                     throws InvalidParameterException,
                                            MissingParameterException,
                                            OperationFailedException,
                                            PermissionDeniedException

Retrieves a list of LuiCapacity Ids by LuiCapacity Type.

Parameters:

luiCapacityTypeKey - a unique identifier for a LuiCapacity Type

contextInfo - information containing the principalId and locale information about the caller of service operation

Returns:

information about a list of Lui Capacities

Throws:

InvalidParameterException - contextInfo is not valid

MissingParameterException - luiCapacityTypeKey or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

getLuiCapacitiesByLui

List<LuiCapacityInfo> getLuiCapacitiesByLui(String luiId,
                                            ContextInfo contextInfo)
                                            throws InvalidParameterException,
                                                   MissingParameterException,
                                                   OperationFailedException,
                                                   PermissionDeniedException

Retrieves LuiCapacities associated with a Lui.

Parameters:

luiId - a unique identifier for a Lui

contextInfo - information containing the principalId and locale information about the caller of service operation

Returns:

a list of LuiCapacities associated with the given Lui

Throws:

InvalidParameterException - contextInfo is not valid

MissingParameterException - luiId or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

searchForLuiCapacityIds

List<String> searchForLuiCapacityIds(QueryByCriteria criteria,
                                     ContextInfo contextInfo)
                                     throws InvalidParameterException,
                                            MissingParameterException,
                                            OperationFailedException,
                                            PermissionDeniedException

Searches for LuiCapacities that meet the search criteria and returns a list of LuiCapacity identifiers that meet the criteria.

Parameters:

criteria - the search criteria

contextInfo - information containing the principalId and locale information about the caller of service operation

Returns:

list of LuiCapacity Ids

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

searchForLuiCapacities

List<LuiCapacityInfo> searchForLuiCapacities(QueryByCriteria criteria,
                                             ContextInfo contextInfo)
                                             throws InvalidParameterException,
                                                    MissingParameterException,
                                                    OperationFailedException,
                                                    PermissionDeniedException

Searches for LuiCapacities that meet the search criteria and returns a list of LuiCapacities that meet the criteria.

Parameters:

criteria - the search criteria

contextInfo - information containing the principalId and locale information about the caller of service operation

Returns:

list of LuiCapacitiess

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

validateLuiCapacity

List<ValidationResultInfo> validateLuiCapacity(String validationTypeKey,
                                               String luiCapacityTypeKey,
                                               LuiCapacityInfo luiCapacityInfo,
                                               ContextInfo contextInfo)
                                               throws DoesNotExistException,
                                                      InvalidParameterException,
                                                      MissingParameterException,
                                                      OperationFailedException,
                                                      PermissionDeniedException

Validates a LuiCapacity. Depending on the value of validationType, this validation could be limited to tests on just the current LuiCapacity and its directly contained sub-objects or expanded to perform all tests related to this LuiCapacity. If an identifier is present for the LuiCapacity (and/or one of its contained sub-objects) and a record is found for that identifier, the validation checks if the LuiCpacity can be updated to the new values. If an identifier is not present or a record does not exist, the validation checks if the object with the given data can be created.

Parameters:

validationTypeKey - the identifier for the validation Type

luiCapacityInfo - the LuiCapacity to be validated

contextInfo - information containing the principalId and locale information about the caller of service operation

Returns:

a list of validation results or an empty list if validation succeeded

Throws:

DoesNotExistException - validationTypeKey or luiCapacityTypeKey not found

InvalidParameterException - luiInfo or contextInfo is not valid

MissingParameterException - validationTypeKey, luiInfo, or contextInfo is missing or null

PermissionDeniedException - an authorization failure occurred

OperationFailedException

createLuiCapacity

LuiCapacityInfo createLuiCapacity(String luiCapacityTypeKey,
                                  LuiCapacityInfo luiCapacityInfo,
                                  ContextInfo contextInfo)
                                  throws DataValidationErrorException,
                                         DoesNotExistException,
                                         InvalidParameterException,
                                         MissingParameterException,
                                         OperationFailedException,
                                         PermissionDeniedException,
                                         ReadOnlyException

Creates a new LuiCapacity. The LuiCapacity Id, Type, and Meta information may not be set in the supplied data.

Parameters:

luiCapacityTypeKey - an identifier for the Type of the new LuiCapacity

luiCapacityInfo - the data with which to create the LuiCapacity

contextInfo - information containing the principalId and locale information about the caller of service operation

Returns:

the new LuiCapacity

Throws:

DataValidationErrorException - supplied data is invalid

DoesNotExistException - luiCapacityTypeKey not found

InvalidParameterException - luiCapacityInfo or contextInfo is not valid

MissingParameterException - luiCapacityTypeKey, luiCapacityInfo, 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

updateLuiCapacity

LuiCapacityInfo updateLuiCapacity(String luiCapacityId,
                                  LuiCapacityInfo luiCapacityInfo,
                                  ContextInfo contextInfo)
                                  throws DataValidationErrorException,
                                         DoesNotExistException,
                                         InvalidParameterException,
                                         MissingParameterException,
                                         OperationFailedException,
                                         PermissionDeniedException,
                                         ReadOnlyException,
                                         VersionMismatchException

Updates an existing LuiCapacity. The LuiCapacity Id, Type, and Meta information may not be changed.

Parameters:

luiCapacityId - the identifier for the LuiCapacity to be updated

luiCapacityInfo - the new data for the LuiCapacity

contextInfo - information containing the principalId and locale information about the caller of service operation

Returns:

the updated LuiCapacity

Throws:

DataValidationErrorException - supplied data is invalid

DoesNotExistException - luiCapacityId not found

InvalidParameterException - luiCapacityInfo or contextInfo is not valid

MissingParameterException - luiCapacityId, luiCapacityInfo, 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 - optimistic locking failure or the action was attempted on an out of date version

deleteLuiCapacity

StatusInfo deleteLuiCapacity(String luiCapacityId,
                             ContextInfo contextInfo)
                             throws DoesNotExistException,
                                    InvalidParameterException,
                                    MissingParameterException,
                                    OperationFailedException,
                                    PermissionDeniedException

Deletes an existing LuiCapacity.

Parameters:

luiCapacityId - the identifier for the LuiCapacity to be deleted

contextInfo - information containing the principalId and locale information about the caller of service operation

Returns:

the status of the delete operation. This must always be true.

Throws:

DoesNotExistException - luiCapacityId not found

InvalidParameterException - contextInfo is invalid

MissingParameterException - luiCapacityId or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

getLuiSetTypes

List<TypeInfo> getLuiSetTypes(ContextInfo contextInfo)
                              throws InvalidParameterException,
                                     MissingParameterException,
                                     OperationFailedException,
                                     PermissionDeniedException

Retrieves the list of Lui set types known by the service

Parameters:

contextInfo - Context information containing the principalId and locale information about the caller of service operation

Returns:

list of Lui set type information

Throws:

InvalidParameterException - invalid contextInfo

MissingParameterException - missing contextInfo

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

getLuiSetType

TypeInfo getLuiSetType(String luiSetTypeKey,
                       ContextInfo contextInfo)
                       throws DoesNotExistException,
                              InvalidParameterException,
                              MissingParameterException,
                              OperationFailedException,
                              PermissionDeniedException

Retrieves information about a specified Lui set type

Parameters:

luiSetTypeKey - Key of the Lui set type

contextInfo - Context information containing the principalId and locale information about the caller of service operation

Returns:

information about a Lui set type

Throws:

DoesNotExistException - LuiSetTypeKey not found

InvalidParameterException - invalid contextInfo

MissingParameterException - missing LuiSetTypeKey or contextInfo

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

getLuiSet

LuiSetInfo getLuiSet(String luiSetId,
                     ContextInfo contextInfo)
                     throws DoesNotExistException,
                            InvalidParameterException,
                            MissingParameterException,
                            OperationFailedException,
                            PermissionDeniedException

Retrieves information on a Lui set.

Parameters:

luiSetId - Identifier of the Lui set

contextInfo - Context information containing the principalId and locale information about the caller of service operation

Returns:

The retrieved Lui set information

Throws:

DoesNotExistException - LuiSetId not found

InvalidParameterException - invalid contextInfo

MissingParameterException - missing LuiSetId or contextInfo

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

getLuiSetsByIds

List<LuiSetInfo> getLuiSetsByIds(List<String> luiSetIds,
                                 ContextInfo contextInfo)
                                 throws DoesNotExistException,
                                        InvalidParameterException,
                                        MissingParameterException,
                                        OperationFailedException,
                                        PermissionDeniedException

Retrieve information on Lui sets from a list of LuiSet Ids.

Parameters:

luiSetIds - List of identifiers of Lui sets

contextInfo - Context information containing the principalId and locale information about the caller of service operation

Returns:

The retrieved list of Lui set information

Throws:

DoesNotExistException - One or more LuiSets not found

InvalidParameterException - invalid contextInfo

MissingParameterException - missing LuiSetIds or contextInfo

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

getLuisFromLuiSet

List<LuiInfo> getLuisFromLuiSet(String luiSetId,
                                ContextInfo contextInfo)
                                throws DoesNotExistException,
                                       InvalidParameterException,
                                       MissingParameterException,
                                       OperationFailedException,
                                       PermissionDeniedException

Retrieves the list of Luis in a Lui set.

Parameters:

luiSetId - Identifier of the Lui set

contextInfo - Context information containing the principalId and locale information about the caller of service operation

Returns:

The retrieved list of information on the Luis within the Lui set

Throws:

DoesNotExistException - LuiSetId not found

InvalidParameterException - invalid contextInfo

MissingParameterException - missing LuiSetId or contextInfo

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

getLuiIdsFromLuiSet

List<String> getLuiIdsFromLuiSet(String luiSetId,
                                 ContextInfo contextInfo)
                                 throws DoesNotExistException,
                                        InvalidParameterException,
                                        MissingParameterException,
                                        OperationFailedException,
                                        PermissionDeniedException

Retrieves the list of Lui Identifiers within a Lui Set.

Parameters:

luiSetId - Identifier of the Lui set

contextInfo - Context information containing the principalId and locale information about the caller of service operation

Returns:

The retrieved list of Lui Ids within the specified Lui set

Throws:

DoesNotExistException - LuiSetId not found

InvalidParameterException - invalid contextInfo

MissingParameterException - missing LuiSetId or contextInfo

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

isLuiInLuiSet

Boolean isLuiInLuiSet(String luiId,
                      String luiSetId,
                      ContextInfo contextInfo)
                      throws DoesNotExistException,
                             InvalidParameterException,
                             MissingParameterException,
                             OperationFailedException,
                             PermissionDeniedException

Checks if a Lui is a member of a Lui set.

Parameters:

luiId - Identifier of the Lui to check

luiSetId - Identifier of the Lui set

contextInfo - Context information containing the principalId and locale information about the caller of service operation

Returns:

True if the Lui is a member of the Lui Set

Throws:

DoesNotExistException - LuiId, LuiSetId not found

InvalidParameterException - invalid contextInfo

MissingParameterException - missing LuiId, LuiSetId or contextInfo

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

validateLuiSet

List<ValidationResultInfo> validateLuiSet(String validationTypeKey,
                                          String luiSetTypeKey,
                                          LuiSetInfo LuiSetInfo,
                                          ContextInfo contextInfo)
                                          throws DoesNotExistException,
                                                 InvalidParameterException,
                                                 MissingParameterException,
                                                 OperationFailedException,
                                                 PermissionDeniedException

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

Parameters:

validationTypeKey - identifier of the extent of validation

luiSetTypeKey - type of the Lui set to be created

LuiSetInfo - Lui set information to be tested.

contextInfo - Context information containing the principalId and locale information about the caller of service operation

Returns:

results from performing the validation

Throws:

DoesNotExistException - validationTypeKey or LuiSetTypeKey not found

InvalidParameterException - invalid LuiSetInfo or contextInfo

MissingParameterException - missing validationTypeKey, LuiSetTypeKey, LuiSetInfo or contextInfo

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

createLuiSet

LuiSetInfo createLuiSet(String luiSetTypeKey,
                        LuiSetInfo luiSetInfo,
                        ContextInfo contextInfo)
                        throws DataValidationErrorException,
                               DoesNotExistException,
                               InvalidParameterException,
                               MissingParameterException,
                               OperationFailedException,
                               PermissionDeniedException,
                               ReadOnlyException,
                               UnsupportedActionException

Creates a Lui set.

Parameters:

luiSetTypeKey - type of the Lui set to be created

luiSetInfo - information required to create a Lui set

contextInfo - Context information containing the principalId and locale information about the caller of service operation

Returns:

the created Lui set information

Throws:

DataValidationErrorException - data validation error

DoesNotExistException - LuiSetTypeKey not found

InvalidParameterException - invalid LuiSetInfo or contextInfo

MissingParameterException - missing LuiSetTypeKey, LuiSetInfo or contextInfo

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

ReadOnlyException - an attempt at supplying information designated as read only

UnsupportedActionException - Lui set need to be static or dynamic but not both

updateLuiSet

LuiSetInfo updateLuiSet(String luiSetId,
                        LuiSetInfo luiSetInfo,
                        ContextInfo contextInfo)
                        throws CircularRelationshipException,
                               DataValidationErrorException,
                               DoesNotExistException,
                               InvalidParameterException,
                               MissingParameterException,
                               OperationFailedException,
                               PermissionDeniedException,
                               ReadOnlyException,
                               UnsupportedActionException,
                               VersionMismatchException

Update the information for a Lui set

Parameters:

luiSetId - identifier of the Lui set to be updated

luiSetInfo - updated information about the Lui set

contextInfo - Context information containing the principalId and locale information about the caller of service operation

Returns:

the updated Lui set information

Throws:

CircularRelationshipException - added LuiSetId cannot be added to the LuiSetInfo

DataValidationErrorException - data validation error

DoesNotExistException - LuiSetId not found

InvalidParameterException - invalid LuiSetInfo or contextInfo

MissingParameterException - missing LuiSetId, LuiSetInfo or contextInfo

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

ReadOnlyException - an attempt at supplying information designated as read only

UnsupportedActionException - Lui set need to be static or dynamic but not both

VersionMismatchException - an optimistic locking failure or the action was attempted on an out of date version

deleteLuiSet

StatusInfo deleteLuiSet(String luiSetId,
                        ContextInfo contextInfo)
                        throws DoesNotExistException,
                               InvalidParameterException,
                               MissingParameterException,
                               OperationFailedException,
                               PermissionDeniedException

Delete a Lui set

Parameters:

luiSetId - identifier of the Lui set to be deleted

contextInfo - Context information containing the principalId and locale information about the caller of service operation

Returns:

status of the operation (success or failure)

Throws:

DoesNotExistException - LuiSetId not found

InvalidParameterException - invalid contextInfo

MissingParameterException - missing LuiSetId or contextInfo

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure