public interface QueueProcessorFrontOfficeSession extends OsidSession
This session provides methods to retrieve QueueProcessor
to FrontOffice
mappings. a QueueProcessor
may appear in multiple FrontOffice
objects. Each front
office may have its own authorizations governing who is allowed to look at
it.
This lookup session defines several views:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupQueueProcessorFrontOfficeMappings()
Tests if this user can perform lookups of queue processor/office
mappings.
|
IdList |
getFrontOfficeIdsByQueueProcessor(Id queueProcessorId)
Gets the
FrontOffice Ids mapped to a
QueueProcessor. |
FrontOfficeList |
getFrontOfficesByQueueProcessor(Id queueProcessorId)
Gets the
FrontOffices mapped to a
QueueProcessor. |
IdList |
getQueueProcessorIdsByFrontOffice(Id frontOfficeId)
Gets the list of
QueueProcessorIds associated with an
FrontFront Office. |
IdList |
getQueueProcessorIdsByFrontOffices(IdList frontOfficeIds)
Gets the list of
QueueProcessor Ids corresponding to a
list of FrontOffices. |
QueueProcessorList |
getQueueProcessorsByFrontOffice(Id frontOfficeId)
Gets the list of queue processors associated with an
FrontFront
Office. |
QueueProcessorList |
getQueueProcessorsByFrontOffices(IdList frontOfficeIds)
Gets the list of queue processor corresponding to a list of
FrontOffices. |
void |
useComparativeQueueProcessorFrontOfficeView()
The returns from the lookup methods may omit or translate elements
based on this session, such as authorization, and not result in an
error.
|
void |
usePlenaryQueueProcessorFrontOfficeView()
A complete view of the
QueueProcessor and
FrontOffice returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupQueueProcessorFrontOfficeMappings()
PERMISSION_DENIED.
This is intended as a hint to an application that may opt not
to offer lookup operations to unauthorized users. false
if looking up mappings is not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeQueueProcessorFrontOfficeView()
mandatory
- This method is must be implemented. void usePlenaryQueueProcessorFrontOfficeView()
QueueProcessor
and
FrontOffice
returns is desired. Methods will return what is
requested or result in an error. This view is used when greater
precision is desired at the expense of interoperability.mandatory
- This method is must be implemented. IdList getQueueProcessorIdsByFrontOffice(Id frontOfficeId) throws NotFoundException, OperationFailedException, PermissionDeniedException
QueueProcessorIds
associated with an
FrontFront Office.
frontOfficeId
- Id
of the FrontOffice
Ids
NotFoundException
- frontOfficeId
is not
foundNullArgumentException
- frontOfficeId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. QueueProcessorList getQueueProcessorsByFrontOffice(Id frontOfficeId) throws NotFoundException, OperationFailedException, PermissionDeniedException
FrontFront
Office.
frontOfficeId
- Id
of the FrontOffice
NotFoundException
- frontOfficeId
is not
foundNullArgumentException
- frontOfficeId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getQueueProcessorIdsByFrontOffices(IdList frontOfficeIds) throws OperationFailedException, PermissionDeniedException
QueueProcessor Ids
corresponding to a
list of FrontOffices.
frontOfficeIds
- list of front office Ids
Ids
NullArgumentException
- frontOfficeIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. QueueProcessorList getQueueProcessorsByFrontOffices(IdList frontOfficeIds) throws OperationFailedException, PermissionDeniedException
FrontOffices.
frontOfficeIds
- list of front office Ids
NullArgumentException
- frontOfficeIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getFrontOfficeIdsByQueueProcessor(Id queueProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
FrontOffice
Ids
mapped to a
QueueProcessor.
queueProcessorId
- Id
of a QueueProcessor
NotFoundException
- queueProcessorId
is
not foundNullArgumentException
- queueProcessorId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. FrontOfficeList getFrontOfficesByQueueProcessor(Id queueProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
FrontOffices
mapped to a
QueueProcessor.
queueProcessorId
- Id
of a QueueProcessor
NotFoundException
- queueProcessorId
is
not foundNullArgumentException
- queueProcessorId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.