public interface QueueDistributorSession extends OsidSession
This session provides methods to retrieve Queue
to
Distributor
mappings. A Queue
may appear in
multiple Distributor
objects. Each distributor 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 |
canLookupQueueDistributorMappings()
Tests if this user can perform lookups of queue/distributor mappings.
|
IdList |
getDistributorIdsByQueue(Id queueId)
Gets the
Distributor Ids mapped to a
Queue. |
DistributorList |
getDistributorsByQueue(Id queueId)
Gets the
Distributors mapped to a Queue. |
IdList |
getQueueIdsByDistributor(Id distributorId)
Gets the list of
Queue Ids associated with a
Distributor. |
IdList |
getQueueIdsByDistributors(IdList distributorIds)
Gets the list of
Queue Ids corresponding to a list of
Distributors. |
QueueList |
getQueuesByDistributor(Id distributorId)
Gets the list of queues associated with a
Distributor. |
QueueList |
getQueuesByDistributors(IdList distributorIds)
Gets the list of queues corresponding to a list of
Distributors. |
void |
useComparativeQueueDistributorView()
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 |
usePlenaryQueueDistributorView()
A complete view of the
Queue and Distributor
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupQueueDistributorMappings()
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 useComparativeQueueDistributorView()
mandatory
- This method is must be implemented. void usePlenaryQueueDistributorView()
Queue
and Distributor
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 getQueueIdsByDistributor(Id distributorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Queue Ids
associated with a
Distributor.
distributorId
- Id
of the Distributor
Ids
NotFoundException
- distributorId
is not
foundNullArgumentException
- distributorId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. QueueList getQueuesByDistributor(Id distributorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Distributor.
distributorId
- Id
of the Distributor
NotFoundException
- distributorId
is not
foundNullArgumentException
- distributorId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getQueueIdsByDistributors(IdList distributorIds) throws OperationFailedException, PermissionDeniedException
Queue Ids
corresponding to a list of
Distributors.
distributorIds
- list of distributor Ids
Ids
NullArgumentException
- distributorIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. QueueList getQueuesByDistributors(IdList distributorIds) throws OperationFailedException, PermissionDeniedException
Distributors.
distributorIds
- list of distributor Ids
NullArgumentException
- distributorIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getDistributorIdsByQueue(Id queueId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Distributor
Ids
mapped 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. DistributorList getDistributorsByQueue(Id queueId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Distributors
mapped 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.