public interface QueueProcessorEnablerFrontOfficeSession extends OsidSession
This session provides methods to retrieve QueueProcessorEnabler
to FrontOffice
mappings. a
QueueProcessorEnabler
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 |
canLookupQueueProcessorEnablerFrontOfficeMappings()
Tests if this user can perform lookups of queue processor
enabler/office mappings.
|
IdList |
getFrontOfficeIdsByQueueProcessorEnabler(Id queueProcessorEnablerId)
Gets the
FrontOffice Ids mapped to a
QueueProcessorEnabler. |
FrontOfficeList |
getFrontOfficesByQueueProcessorEnabler(Id queueProcessorEnablerId)
Gets the
FrontOffices mapped to a
QueueProcessorEnabler. |
IdList |
getQueueProcessorEnablerIdsByFrontOffice(Id frontOfficeId)
Gets the list of
QueueProcessorEnablerIds associated
with an FrontFront Office. |
IdList |
getQueueProcessorEnablerIdsByFrontOffices(IdList frontOfficeIds)
Gets the list of
QueueProcessorEnabler Ids
corresponding to a list of FrontOffices. |
QueueProcessorEnablerList |
getQueueProcessorEnablersByFrontOffice(Id frontOfficeId)
Gets the list of queue processor enablers associated with an
FrontFront Office. |
QueueProcessorEnablerList |
getQueueProcessorEnablersByFrontOffices(IdList frontOfficeIds)
Gets the list of queue processor enablers corresponding to a list of
FrontOffices. |
void |
useComparativeQueueProcessorEnablerFrontOfficeView()
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 |
usePlenaryQueueProcessorEnablerFrontOfficeView()
A complete view of the
QueueProcessorEnabler and
FrontOffice returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupQueueProcessorEnablerFrontOfficeMappings()
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 useComparativeQueueProcessorEnablerFrontOfficeView()
mandatory
- This method is must be implemented. void usePlenaryQueueProcessorEnablerFrontOfficeView()
QueueProcessorEnabler
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 getQueueProcessorEnablerIdsByFrontOffice(Id frontOfficeId) throws NotFoundException, OperationFailedException, PermissionDeniedException
QueueProcessorEnablerIds
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. QueueProcessorEnablerList getQueueProcessorEnablersByFrontOffice(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 getQueueProcessorEnablerIdsByFrontOffices(IdList frontOfficeIds) throws OperationFailedException, PermissionDeniedException
QueueProcessorEnabler 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. QueueProcessorEnablerList getQueueProcessorEnablersByFrontOffices(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 getFrontOfficeIdsByQueueProcessorEnabler(Id queueProcessorEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
FrontOffice
Ids
mapped to a
QueueProcessorEnabler.
queueProcessorEnablerId
- Id
of a
QueueProcessorEnabler
NotFoundException
- queueProcessorEnablerId
is not foundNullArgumentException
- queueProcessorEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. FrontOfficeList getFrontOfficesByQueueProcessorEnabler(Id queueProcessorEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
FrontOffices
mapped to a
QueueProcessorEnabler.
queueProcessorEnablerId
- Id
of a
QueueProcessorEnabler
NotFoundException
- queueProcessorEnablerId
is not foundNullArgumentException
- queueProcessorEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.