public interface QueueProcessorDistributorSession extends OsidSession
This session provides methods to retrieve QueueProcessor
to Distributor
mappings. a QueueProcessor
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 |
canLookupQueueProcessorDistributorMappings()
Tests if this user can perform lookups of queue processor/distributor
mappings.
|
IdList |
getDistributorIdsByQueueProcessor(Id queueProcessorId)
Gets the
Distributor Ids mapped to a
QueueProcessor. |
DistributorList |
getDistributorsByQueueProcessor(Id queueProcessorId)
Gets the
Distributors mapped to a
QueueProcessor. |
IdList |
getQueueProcessorIdsByDistributor(Id distributorId)
Gets the list of
QueueProcessorIds associated with a
Distributor. |
IdList |
getQueueProcessorIdsByDistributors(IdList distributorIds)
Gets the list of
QueueProcessor Ids corresponding to a
list of Distributors. |
QueueProcessorList |
getQueueProcessorsByDistributor(Id distributorId)
Gets the list of queue processors associated with a
Distributor. |
QueueProcessorList |
getQueueProcessorsByDistributors(IdList distributorIds)
Gets the list of queue processor corresponding to a list of
Distributors. |
void |
useComparativeQueueProcessorDistributorView()
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 |
usePlenaryQueueProcessorDistributorView()
A complete view of the
QueueProcessor and
Distributor returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupQueueProcessorDistributorMappings()
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 useComparativeQueueProcessorDistributorView()
mandatory
- This method is must be implemented. void usePlenaryQueueProcessorDistributorView()
QueueProcessor
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 getQueueProcessorIdsByDistributor(Id distributorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
QueueProcessorIds
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. QueueProcessorList getQueueProcessorsByDistributor(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 getQueueProcessorIdsByDistributors(IdList distributorIds) throws OperationFailedException, PermissionDeniedException
QueueProcessor 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. QueueProcessorList getQueueProcessorsByDistributors(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 getDistributorIdsByQueueProcessor(Id queueProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Distributor
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. DistributorList getDistributorsByQueueProcessor(Id queueProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Distributors
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.