org.kuali.student.enrollment.roster.service

Interface LprRosterService

All Known Implementing Classes:

LprRosterServiceDecorator, LprRosterServiceMapImpl, LprRosterServiceValidationDecorator

public interface LprRosterService

The LprRoster service maintains ordered collections of Lprs for various applications such as waitlists and grading sheets.

Version:

0.0.7

Method Summary

Methods

Modifier and Type	Method and Description
LprRosterInfo	createLprRoster(String lprRosterTypeKey, LprRosterInfo lprRosterInfo, ContextInfo contextInfo) Creates a new LprRoster.
LprRosterEntryInfo	createLprRosterEntry(String lprRosterId, String lprId, String lprRosterEntryTypeKey, LprRosterEntryInfo lprRosterEntryInfo, ContextInfo contextInfo) Creates a new LprRosterEntry.
StatusInfo	deleteLprRoster(String lprRosterId, ContextInfo contextInfo) Deletes an existing LprRoster.
StatusInfo	deleteLprRosterEntry(String lprRosterEntryId, ContextInfo contextInfo) Deletes an existing LprRosterEntry.
LprRosterInfo	getLprRoster(String lprRosterId, ContextInfo contextInfo) Retrieves a single LprRoster by an LprRoster Id.
List<LprRosterEntryInfo>	getLprRosterEntriesByIds(List<String> lprRosterEntryIds, ContextInfo contextInfo) Retrieve a list of LprRosterEntriess from a list of LprRosterEntry Ids.
List<LprRosterEntryInfo>	getLprRosterEntriesByLpr(String lprId, ContextInfo contextInfo) This method returns all the LprRosterEntries for an LPR.
List<LprRosterEntryInfo>	getLprRosterEntriesByLprRoster(String lprRosterId, ContextInfo contextInfo) This method returns all the LprRosterEntries for an LprRoster.
List<LprRosterEntryInfo>	getLprRosterEntriesByLprRosterAndLpr(String lprRosterId, String lprId, ContextInfo contextInfo) This method returns all the LprRosterEntries to the given LprRoster and Lpr.
LprRosterEntryInfo	getLprRosterEntry(String lprRosterEntryId, ContextInfo contextInfo) Retrieves a single LprRosterEntry by an LprRosterEntry Id.
List<String>	getLprRosterEntryIdsByType(String lprRosterEntryTypeKey, ContextInfo contextInfo) Retrieve a list of LprRosterENtryIds by LprRosterEntry Type.
List<String>	getLprRosterIdsByType(String lprRosterTypeKey, ContextInfo contextInfo) Retrieve a list of LprRosterIds by LprRoster Type.
List<LprRosterInfo>	getLprRostersByIds(List<String> lprRosterIds, ContextInfo contextInfo) Retrieve a list of LprRosters from a list of LprRoster Ids.
List<LprRosterInfo>	getLprRostersByLui(String luiId, ContextInfo contextInfo) Gets a list of LprRosters associated with a given Lui.
List<LprRosterInfo>	getLprRostersByTypeAndLui(String lprRosterTypeKey, String luiId, ContextInfo contextInfo) Gets a list of LprRosters associated with a given LprRoster Type and Lui.
StatusInfo	moveLprRosterEntryToPosition(String lprRosterEntryId, Integer position, ContextInfo contextInfo) Inserts an existing roster entry at a particular position on the roster.
StatusInfo	reorderLprRosterEntries(String lprRosterId, List<String> lprRosterEntryIds, ContextInfo contextInfo) Reorders all the LprRosterEntries setting their position to match the order within the specified list of LprRosterEntry Ids.
List<LprRosterEntryInfo>	searchForLprRosterEntries(QueryByCriteria criteria, ContextInfo contextInfo) Searches for LprRosterEntris that meet the given search criteria.
List<String>	searchForLprRosterEntryIds(QueryByCriteria criteria, ContextInfo contextInfo) Searches for LprRosterEntries that meet the given search criteria.
List<String>	searchForLprRosterIds(QueryByCriteria criteria, ContextInfo contextInfo) Searches for LprRosters that meet the given search criteria.
List<LprRosterInfo>	searchForLprRosters(QueryByCriteria criteria, ContextInfo contextInfo) Searches for LprRosters that meet the given search criteria.
LprRosterInfo	updateLprRoster(String lprRosterId, LprRosterInfo lprRosterInfo, ContextInfo contextInfo) Updates an existing LprRoster.
LprRosterEntryInfo	updateLprRosterEntry(String lprRosterEntryId, LprRosterEntryInfo lprRosterEntryInfo, ContextInfo contextInfo) Updates an existing LprRosterEntry.
List<ValidationResultInfo>	validateLprRoster(String validationTypeKey, String lprRosterTypeKey, LprRosterInfo lprRosterInfo, ContextInfo contextInfo) Validates an LprRoster.
List<ValidationResultInfo>	validateLprRosterEntry(String validationTypeKey, String lprRosterId, String lprId, String lprRosterEntryTypeKey, LprRosterEntryInfo lprRosterEntryInfo, ContextInfo contextInfo) Validates an LprRosterEntry.

Method Detail

getLprRoster

LprRosterInfo getLprRoster(String lprRosterId,
                         ContextInfo contextInfo)
                           throws DoesNotExistException,
                                  InvalidParameterException,
                                  MissingParameterException,
                                  OperationFailedException,
                                  PermissionDeniedException

Retrieves a single LprRoster by an LprRoster Id.

Parameters:

lprRosterId - the identifier for the LprRoster to be retrieved

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

Returns:

the LprRoster requested

Throws:

DoesNotExistException - lprRosterId is not found

InvalidParameterException - contextInfo is not valid

MissingParameterException - lprRosterId or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

getLprRostersByIds

List<LprRosterInfo> getLprRostersByIds(List<String> lprRosterIds,
                                     ContextInfo contextInfo)
                                       throws DoesNotExistException,
                                              InvalidParameterException,
                                              MissingParameterException,
                                              OperationFailedException,
                                              PermissionDeniedException

Retrieve a list of LprRosters from a list of LprRoster Ids. The returned list may be in any order and if duplicate Ids are supplied, a unique set may or may not ber returned.

Parameters:

lprRosterIds - a list of LprRoster identifiers

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

Returns:

a list of LprRosters

Throws:

DoesNotExistException - a lprRosterId in the list was not found

InvalidParameterException - contextInfo is not valid

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

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

getLprRosterIdsByType

List<String> getLprRosterIdsByType(String lprRosterTypeKey,
                                 ContextInfo contextInfo)
                                   throws InvalidParameterException,
                                          MissingParameterException,
                                          OperationFailedException,
                                          PermissionDeniedException

Retrieve a list of LprRosterIds by LprRoster Type.

Parameters:

lprRosterTypeKey - an identifier for an LprRoster Type

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

Returns:

a list of LprRosters identifiers matching lprRosterTypeKey or an empty list of none found

Throws:

InvalidParameterException - contextInfo is not valid

MissingParameterException - lprRosterTypeKey or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

getLprRostersByLui

List<LprRosterInfo> getLprRostersByLui(String luiId,
                                     ContextInfo contextInfo)
                                       throws InvalidParameterException,
                                              MissingParameterException,
                                              OperationFailedException,
                                              PermissionDeniedException

Gets a list of LprRosters associated with a given Lui.

Parameters:

luiId - an identifier for a LUI

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

Returns:

list of LprRosters associated with the given Lui or an empty list if none found

Throws:

InvalidParameterException - contextInfo is not valid

MissingParameterException - luiId or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

getLprRostersByTypeAndLui

List<LprRosterInfo> getLprRostersByTypeAndLui(String lprRosterTypeKey,
                                            String luiId,
                                            ContextInfo contextInfo)
                                              throws InvalidParameterException,
                                                     MissingParameterException,
                                                     OperationFailedException,
                                                     PermissionDeniedException

Gets a list of LprRosters associated with a given LprRoster Type and Lui.

Parameters:

lprRosterTypeKey - an identifier for an LprRoster Type

luiId - an identifier for a Lui

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

Returns:

list of LprRosters of the given LprRoster Type and associated with the given Lui or an empty list if none found

Throws:

InvalidParameterException - contextInfo is not valid

MissingParameterException - lprRosterTypeKey, luiId or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

searchForLprRosterIds

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

Searches for LprRosters that meet the given search criteria.

Parameters:

criteria - the search criteria

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

Returns:

a list of LprRoster identifiers matching the criteria

Throws:

InvalidParameterException - criteria or contextInfo is not valid

MissingParameterException - criteria or or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

searchForLprRosters

List<LprRosterInfo> searchForLprRosters(QueryByCriteria criteria,
                                      ContextInfo contextInfo)
                                        throws InvalidParameterException,
                                               MissingParameterException,
                                               OperationFailedException,
                                               PermissionDeniedException

Searches for LprRosters that meet the given search criteria.

Parameters:

criteria - the search criteria

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

Returns:

a list of LprRosters matching the criteria

Throws:

InvalidParameterException - criteria or contextInfo is not valid

MissingParameterException - criteria or or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

validateLprRoster

List<ValidationResultInfo> validateLprRoster(String validationTypeKey,
                                           String lprRosterTypeKey,
                                           LprRosterInfo lprRosterInfo,
                                           ContextInfo contextInfo)
                                             throws DoesNotExistException,
                                                    InvalidParameterException,
                                                    MissingParameterException,
                                                    OperationFailedException,
                                                    PermissionDeniedException

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

Parameters:

validationTypeKey - the identifier for the validation Type

lprRosterTypeKey - the identifier for the LprRoster Type to be validated

lprRosterInfo - the LprRoster to be validated

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

Returns:

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

Throws:

DoesNotExistException - validationTypeKey or lprRosterTypeKey is not found

InvalidParameterException - lprRosterInfo or contextInfo is not valid

MissingParameterException - validationTypeKey, lprRosterTypeKey, lprRosterInfo, or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

createLprRoster

LprRosterInfo createLprRoster(String lprRosterTypeKey,
                            LprRosterInfo lprRosterInfo,
                            ContextInfo contextInfo)
                              throws DataValidationErrorException,
                                     DoesNotExistException,
                                     InvalidParameterException,
                                     MissingParameterException,
                                     OperationFailedException,
                                     PermissionDeniedException,
                                     ReadOnlyException

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

Parameters:

lprRosterTypeKey - the identifier for the Type of LprRoster to be created

lprRosterInfo - the data with which to create the LprRoster

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

Returns:

the new LprRoster

Throws:

DataValidationErrorException - supplied data is invalid

DoesNotExistException - lprRosterTypeKey does not exist or is not supported

InvalidParameterException - lprRosterInfo or contextInfo is not valid

MissingParameterException - lprRosterTypeKey, lprRosterInfo, 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

updateLprRoster

LprRosterInfo updateLprRoster(String lprRosterId,
                            LprRosterInfo lprRosterInfo,
                            ContextInfo contextInfo)
                              throws DataValidationErrorException,
                                     DoesNotExistException,
                                     InvalidParameterException,
                                     MissingParameterException,
                                     OperationFailedException,
                                     PermissionDeniedException,
                                     ReadOnlyException,
                                     VersionMismatchException

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

Parameters:

lprRosterId - the identifier for the LprRoster to be updated

lprRosterInfo - the new data for the LprRoster

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

Returns:

the updated LprRoster

Throws:

DataValidationErrorException - supplied data is invalid

DoesNotExistException - lprRosterId is not found

InvalidParameterException - lprRosterInfo or contextInfo is not valid

MissingParameterException - lprRosterId, lprRosterInfo, 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

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

deleteLprRoster

StatusInfo deleteLprRoster(String lprRosterId,
                         ContextInfo contextInfo)
                           throws DoesNotExistException,
                                  InvalidParameterException,
                                  MissingParameterException,
                                  OperationFailedException,
                                  PermissionDeniedException

Deletes an existing LprRoster.

Parameters:

lprRosterId - the identifier for the LprRoster to be deleted

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

Returns:

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

Throws:

DoesNotExistException - lprRosterId is not found

InvalidParameterException - contextInfo is not valid

MissingParameterException - lprRosterId or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

getLprRosterEntry

LprRosterEntryInfo getLprRosterEntry(String lprRosterEntryId,
                                   ContextInfo contextInfo)
                                     throws DoesNotExistException,
                                            InvalidParameterException,
                                            MissingParameterException,
                                            OperationFailedException,
                                            PermissionDeniedException

Retrieves a single LprRosterEntry by an LprRosterEntry Id.

Parameters:

lprRosterEntryId - the identifier for the LprRosterEntry to be retrieved

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

Returns:

the LprRosterEntry requested

Throws:

DoesNotExistException - lprRosterEntryId is not found

InvalidParameterException - contextInfo is not valid

MissingParameterException - lprRosterEntryId or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

getLprRosterEntriesByIds

List<LprRosterEntryInfo> getLprRosterEntriesByIds(List<String> lprRosterEntryIds,
                                                ContextInfo contextInfo)
                                                  throws DoesNotExistException,
                                                         InvalidParameterException,
                                                         MissingParameterException,
                                                         OperationFailedException,
                                                         PermissionDeniedException

Retrieve a list of LprRosterEntriess from a list of LprRosterEntry Ids. The returned list may be in any order and if duplicate Ids are supplied, a unique set may or may not ber returned.

Parameters:

lprRosterEntryIds - a list of LprRosterEntry identifiers

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

Returns:

a list of LprRosterEntries

Throws:

DoesNotExistException - a lprRosterEntryId in the list was not found

InvalidParameterException - contextInfo is not valid

MissingParameterException - lprRosterEntryIds, an Id in lprRosterIds, or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

getLprRosterEntryIdsByType

List<String> getLprRosterEntryIdsByType(String lprRosterEntryTypeKey,
                                      ContextInfo contextInfo)
                                        throws InvalidParameterException,
                                               MissingParameterException,
                                               OperationFailedException,
                                               PermissionDeniedException

Retrieve a list of LprRosterENtryIds by LprRosterEntry Type.

Parameters:

lprRosterEntryTypeKey - an identifier for an LprRosterEntry Type

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

Returns:

a list of LprRosterEntries identifiers matching lprRosterEntryTypeKey or an empty list of none found

Throws:

InvalidParameterException - contextInfo is not valid

MissingParameterException - lprRosterEntryTypeKey or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

getLprRosterEntriesByLprRoster

List<LprRosterEntryInfo> getLprRosterEntriesByLprRoster(String lprRosterId,
                                                      ContextInfo contextInfo)
                                                        throws InvalidParameterException,
                                                               MissingParameterException,
                                                               OperationFailedException,
                                                               PermissionDeniedException

This method returns all the LprRosterEntries for an LprRoster. The returned list will be ordered by LprRosterEntryInfo.position starting with position 1.

Parameters:

lprRosterId - an identifier for an LprRoster

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

Returns:

a list of LprRosterEntries identifiers for the given LprRoster or an empty list of none found

Throws:

InvalidParameterException - contextInfo is not valid

MissingParameterException - lprRosterId or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

getLprRosterEntriesByLpr

List<LprRosterEntryInfo> getLprRosterEntriesByLpr(String lprId,
                                                ContextInfo contextInfo)
                                                  throws InvalidParameterException,
                                                         MissingParameterException,
                                                         OperationFailedException,
                                                         PermissionDeniedException

This method returns all the LprRosterEntries for an LPR.

Parameters:

lprId - an identifier for an Lpr

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

Returns:

a list of LprRosterEntries identifiers for the given Lpr or an empty list of none found

Throws:

InvalidParameterException - contextInfo is not valid

MissingParameterException - lprId or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

getLprRosterEntriesByLprRosterAndLpr

List<LprRosterEntryInfo> getLprRosterEntriesByLprRosterAndLpr(String lprRosterId,
                                                            String lprId,
                                                            ContextInfo contextInfo)
                                                              throws InvalidParameterException,
                                                                     MissingParameterException,
                                                                     OperationFailedException,
                                                                     PermissionDeniedException

This method returns all the LprRosterEntries to the given LprRoster and Lpr.

Parameters:

lprRosterId - an identifier for an LprRoster

lprId - an identifier for an Lpr

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

Returns:

a list of LprRosterEntries identifiers for the given LprRoster and Lpr or an empty list of none found

Throws:

InvalidParameterException - contextInfo is not valid

MissingParameterException - lprRosterId, lprId, or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

searchForLprRosterEntryIds

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

Searches for LprRosterEntries that meet the given search criteria.

Parameters:

criteria - the search criteria

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

Returns:

a list of LprRosterEntry identifiers matching the criteria

Throws:

InvalidParameterException - criteria or contextInfo is not valid

MissingParameterException - criteria or or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

searchForLprRosterEntries

List<LprRosterEntryInfo> searchForLprRosterEntries(QueryByCriteria criteria,
                                                 ContextInfo contextInfo)
                                                   throws InvalidParameterException,
                                                          MissingParameterException,
                                                          OperationFailedException,
                                                          PermissionDeniedException

Searches for LprRosterEntris that meet the given search criteria.

Parameters:

criteria - the search criteria

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

Returns:

a list of LprRosterEntries matching the criteria

Throws:

InvalidParameterException - criteria or contextInfo is not valid

MissingParameterException - criteria or or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

validateLprRosterEntry

List<ValidationResultInfo> validateLprRosterEntry(String validationTypeKey,
                                                String lprRosterId,
                                                String lprId,
                                                String lprRosterEntryTypeKey,
                                                LprRosterEntryInfo lprRosterEntryInfo,
                                                ContextInfo contextInfo)
                                                  throws DoesNotExistException,
                                                         InvalidParameterException,
                                                         MissingParameterException,
                                                         OperationFailedException,
                                                         PermissionDeniedException

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

Parameters:

validationTypeKey - the identifier for the validation Type

lprRosterId - the LprRoster of the LprRosterEntry

lprId - the Lpr of the LprRosterEntry

lprRosterEntryTypeKey - the identifier for the LprRosterEntry Type to be validated

lprRosterEntryInfo - the LprRosterEntry to be validated

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

Returns:

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

Throws:

DoesNotExistException - validationTypeKey, lprRosterId, or lprId, or lprRosterEntryTypeKey is not found

InvalidParameterException - lprRosterEntryInfo or contextInfo is not valid

MissingParameterException - validationTypeKey, lprRosterId, lprId, lprRosterTypeKey, lprRosterInfo, or lprRosterEntryInfo, or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

createLprRosterEntry

LprRosterEntryInfo createLprRosterEntry(String lprRosterId,
                                      String lprId,
                                      String lprRosterEntryTypeKey,
                                      LprRosterEntryInfo lprRosterEntryInfo,
                                      ContextInfo contextInfo)
                                        throws DataValidationErrorException,
                                               DoesNotExistException,
                                               InvalidParameterException,
                                               MissingParameterException,
                                               OperationFailedException,
                                               PermissionDeniedException,
                                               ReadOnlyException

Creates a new LprRosterEntry. The LprRosterEntry Id, LprRosterId, Lpr Id, Type, and Meta information may not be set in the supplied data object.

Parameters:

lprRosterId - the LprRoster of the LprRosterEntry

lprId - the Lpr of the LprRosterEntry

lprRosterEntryTypeKey - the identifier for the Type of LprRosterEntry to be created

lprRosterEntryInfo - the data with which to create the LprRoster

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

Returns:

the new LprRosterEntry

Throws:

DataValidationErrorException - supplied data is invalid

DoesNotExistException - lprRosterId, lprId, or lprRosterEntryTypeKey does not exist or is not supported

InvalidParameterException - lprRosterEntryInfo or contextInfo is not valid

MissingParameterException - lprRosterId, lprId, lprRosterEntryTypeKey, lprRosterInfo, 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

updateLprRosterEntry

LprRosterEntryInfo updateLprRosterEntry(String lprRosterEntryId,
                                      LprRosterEntryInfo lprRosterEntryInfo,
                                      ContextInfo contextInfo)
                                        throws DataValidationErrorException,
                                               DoesNotExistException,
                                               InvalidParameterException,
                                               MissingParameterException,
                                               OperationFailedException,
                                               PermissionDeniedException,
                                               ReadOnlyException,
                                               VersionMismatchException

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

Parameters:

lprRosterEntryId - the identifier for the LprRosterEntry to be updated

lprRosterEntryInfo - the new data for the LprRosterEntry

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

Returns:

the updated LprRosterEntry

Throws:

DataValidationErrorException - supplied data is invalid

DoesNotExistException - lprRosterEntryId is not found

InvalidParameterException - lprRosterEntryInfo or contextInfo is not valid

MissingParameterException - lprRosterEntryId, lprRosterEntryInfo, 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

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

deleteLprRosterEntry

StatusInfo deleteLprRosterEntry(String lprRosterEntryId,
                              ContextInfo contextInfo)
                                throws DoesNotExistException,
                                       InvalidParameterException,
                                       MissingParameterException,
                                       OperationFailedException,
                                       PermissionDeniedException

Deletes an existing LprRosterEntry.

Parameters:

lprRosterEntryId - the identifier for the LprRosterEntry to be deleted

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

Returns:

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

Throws:

DoesNotExistException - lprRosterEntryId is not found

InvalidParameterException - contextInfo is not valid

MissingParameterException - lprRosterEntryId or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

moveLprRosterEntryToPosition

StatusInfo moveLprRosterEntryToPosition(String lprRosterEntryId,
                                      Integer position,
                                      ContextInfo contextInfo)
                                        throws DoesNotExistException,
                                               InvalidParameterException,
                                               MissingParameterException,
                                               OperationFailedException,
                                               PermissionDeniedException

Inserts an existing roster entry at a particular position on the roster. If another roster entry already exists at that particular position within the roster then this method "bumps down" the rest of the roster entries until there is an open position.

Parameters:

lprRosterEntryId - the id for the lpr roster entry to be moved.

position - the absolute position in the LprRoster

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

Throws:

DoesNotExistException - lprRosterEntryId is not found

InvalidParameterException - contextInfo is not valid

MissingParameterException - lprRosterEntryId or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

reorderLprRosterEntries

StatusInfo reorderLprRosterEntries(String lprRosterId,
                                 List<String> lprRosterEntryIds,
                                 ContextInfo contextInfo)
                                   throws DoesNotExistException,
                                          InvalidParameterException,
                                          MissingParameterException,
                                          OperationFailedException,
                                          PermissionDeniedException

Reorders all the LprRosterEntries setting their position to match the order within the specified list of LprRosterEntry Ids. This is a bulk method to reset the positions all of the entries in the LprRoster. Any entries in the LprRoster that are not specified in the supplied list are ordered by their existing position and placed at the end of the LprRosterEntries in the specified list.

Parameters:

lprRosterId - the LprRoster to reorder. All supplied LprRosterEntryIds must belong to the given LprRoster.

lprRosterEntryIds - an ordered list of LprRosterEntries

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

Throws:

DoesNotExistException - an lprRosterEntryId in the list is not found

InvalidParameterException - contextInfo is not valid

MissingParameterException - lprRosterEntryIds, an Id in lprRosterEntryIds, or conetxtInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred