public interface QueueConstrainerDistributorSession extends OsidSession
This session provides methods to retrieve QueueConstrainer
to Distributor
mappings. a QueueConstrainer
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 |
canLookupQueueConstrainerDistributorMappings()
Tests if this user can perform lookups of queue
constrainer/distributor mappings.
|
IdList |
getDistributorIdsByQueueConstrainer(Id queueConstrainerId)
Gets the
Distributor Ids mapped to a
QueueConstrainer. |
DistributorList |
getDistributorsByQueueConstrainer(Id queueConstrainerId)
Gets the
Distributors mapped to a
QueueConstrainer. |
IdList |
getQueueConstrainerIdsByDistributor(Id distributorId)
Gets the list of
QueueConstrainerIds associated with a
Distributor. |
IdList |
getQueueConstrainerIdsByDistributors(IdList distributorIds)
Gets the list of
QueueConstrainer Ids corresponding to
a list of Distributors. |
QueueConstrainerList |
getQueueConstrainersByDistributor(Id distributorId)
Gets the list of queue constrainer associated with a
Distributor. |
QueueConstrainerList |
getQueueConstrainersByDistributors(IdList distributorIds)
Gets the list of queue constrainer corresponding to a list of
Distributors. |
void |
useComparativeQueueConstrainerDistributorView()
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 |
usePlenaryQueueConstrainerDistributorView()
A complete view of the
QueueConstrainer and
Distributor returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupQueueConstrainerDistributorMappings()
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 useComparativeQueueConstrainerDistributorView()
mandatory
- This method is must be implemented. void usePlenaryQueueConstrainerDistributorView()
QueueConstrainer
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 getQueueConstrainerIdsByDistributor(Id distributorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
QueueConstrainerIds
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. QueueConstrainerList getQueueConstrainersByDistributor(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 getQueueConstrainerIdsByDistributors(IdList distributorIds) throws OperationFailedException, PermissionDeniedException
QueueConstrainer 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. QueueConstrainerList getQueueConstrainersByDistributors(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 getDistributorIdsByQueueConstrainer(Id queueConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Distributor
Ids
mapped to a
QueueConstrainer.
queueConstrainerId
- Id
of a
QueueConstrainer
NotFoundException
- queueConstrainerId
is not foundNullArgumentException
- queueConstrainerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DistributorList getDistributorsByQueueConstrainer(Id queueConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Distributors
mapped to a
QueueConstrainer.
queueConstrainerId
- Id
of a
QueueConstrainer
NotFoundException
- queueConstrainerId
is not foundNullArgumentException
- queueConstrainerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.