public interface QueueFrontOfficeSession extends OsidSession
This session provides methods to retrieve Queue
to
FrontOffice
mappings. A Queue
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 |
canLookupQueueFrontOfficeIssues()
Tests if this user can perform lookups of queue/front office mappings.
|
IdList |
getFrontOfficeIdsByQueue(Id queueId)
Gets the
FrontOffice Ids frontOfficeped
to a Queue. |
FrontOfficeList |
getFrontOfficesByQueue(Id queueId)
Gets the
FrontOffices frontOfficeped to a Queue. |
IdList |
getQueueIdsByFrontOffice(Id frontOfficeId)
Gets the list of
Queue Ids associated with a
FrontOffice. |
IdList |
getQueueIdsByFrontOffices(IdList frontOfficeIds)
Gets the list of
Queue Ids corresponding to a list of
FrontOffices. |
QueueList |
getQueuesByFrontOffice(Id frontOfficeId)
Gets the list of
Queues associated with a
FrontOffice. |
QueueList |
getQueuesByFrontOffices(IdList frontOfficeIds)
Gets the list of
Queue corresponding to a list of
FrontOffices. |
void |
useComparativeQueueFrontOfficeView()
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 |
usePlenaryQueueFrontOfficeView()
A complete view of the
Queue and FrontOffice
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupQueueFrontOfficeIssues()
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 useComparativeQueueFrontOfficeView()
mandatory
- This method is must be implemented. void usePlenaryQueueFrontOfficeView()
Queue
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 getQueueIdsByFrontOffice(Id frontOfficeId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Queue Ids
associated with a
FrontOffice.
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. QueueList getQueuesByFrontOffice(Id frontOfficeId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Queues
associated with a
FrontOffice.
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 getQueueIdsByFrontOffices(IdList frontOfficeIds) throws OperationFailedException, PermissionDeniedException
Queue 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. QueueList getQueuesByFrontOffices(IdList frontOfficeIds) throws OperationFailedException, PermissionDeniedException
Queue
corresponding to a list of
FrontOffices.
frontOfficeIds
- list of front office Ids
NullArgumentException
- frontOfficeIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getFrontOfficeIdsByQueue(Id queueId) throws NotFoundException, OperationFailedException, PermissionDeniedException
FrontOffice
Ids
frontOfficeped
to a Queue.
queueId
- Id
of a Queue
NotFoundException
- queueId
is not foundNullArgumentException
- queueId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. FrontOfficeList getFrontOfficesByQueue(Id queueId) throws NotFoundException, OperationFailedException, PermissionDeniedException
FrontOffices
frontOfficeped to a Queue.
queueId
- Id
of a Queue
NotFoundException
- queueId
is not foundNullArgumentException
- queueId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.