public interface QueueProcessorRuleLookupSession extends OsidSession
This session provides methods to retrieve QueueProcessor
to Queue
mappings.
This lookup session defines several views:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupQueueProcessorRules()
Tests if this user can perform lookups of queue processor/queue
mappings.
|
FrontOffice |
getFrontOffice()
Gets the
FrontOffice associated with this session. |
Id |
getFrontOfficeId()
Gets the
FrontOffice Id associated with
this session. |
IdList |
getQueueIdsForQueueProcessor(Id queueProcessorId)
Gets the
Queue Ids mapped to a
QueueProcessor. |
IdList |
getQueueProcessorIdsForQueue(Id queueId)
Gets the
QueueProcessor Id associated with a
Queue. |
QueueProcessorList |
getQueueProcessorsForQueue(Id queueId)
Gets the
QueueProcessor associated with a Queue. |
QueueList |
getQueuesForQueueProcessor(Id queueProcessorId)
Gets the
Queues mapped to a QueueProcessor. |
void |
useComparativeQueueProcessorRuleView()
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 |
useFederatedFrontOfficeView()
Federates the view for methods in this session.
|
void |
useIsolatedFrontOfficeView()
Isolates the view for methods in this session.
|
void |
usePlenaryQueueProcessorRuleView()
A complete view of the
QueueProcessor and Queue
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getFrontOfficeId()
FrontOffice
Id
associated with
this session. FrontOffice Id
associated with this sessionmandatory
- This method must be implemented. FrontOffice getFrontOffice() throws OperationFailedException, PermissionDeniedException
FrontOffice
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupQueueProcessorRules()
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 useComparativeQueueProcessorRuleView()
mandatory
- This method is must be implemented. void usePlenaryQueueProcessorRuleView()
QueueProcessor
and Queue
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. void useFederatedFrontOfficeView()
mandatory
- This method is must be implemented. void useIsolatedFrontOfficeView()
mandatory
- This method is must be implemented. IdList getQueueProcessorIdsForQueue(Id queueId) throws NotFoundException, OperationFailedException, PermissionDeniedException
QueueProcessor Id
associated with a
Queue.
queueId
- Id
of the Queue
Ids
NotFoundException
- queueId
is not foundNullArgumentException
- queueId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. QueueProcessorList getQueueProcessorsForQueue(Id queueId) throws NotFoundException, OperationFailedException, PermissionDeniedException
QueueProcessor
associated with a Queue.
queueId
- Id
of the Auction
NotFoundException
- queueId
is not foundNullArgumentException
- queueId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getQueueIdsForQueueProcessor(Id queueProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Queue
Ids
mapped to a
QueueProcessor.
queueProcessorId
- Id
of a QueueProcessor
Ids
NotFoundException
- queueProcessorId
is
not foundNullArgumentException
- queueProcessorId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. QueueList getQueuesForQueueProcessor(Id queueProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Queues
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.