public interface QueueConstrainerRuleLookupSession extends OsidSession
This session provides methods to retrieve QueueConstrainer
to Queue
mappings. A Queue
with
multiple QueueConstrainers
means any positive rule
evaluation across the constrainers result in an accessible Queue.
This lookup session defines several views:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupQueueConstrainerRules()
Tests if this user can perform lookups of queue constrainer/queue
mappings.
|
FrontOffice |
getFrontOffice()
Gets the
FrontOffice associated with this session. |
Id |
getFrontOfficeId()
Gets the
FrontOffice Id associated with
this session. |
IdList |
getQueueConstrainerIdsForQueue(Id queueId)
Gets the
QueueConstrainer Id associated with a
Queue. |
QueueConstrainerList |
getQueueConstrainersForQueue(Id queueId)
Gets the
QueueConstrainer associated with a
Queue. |
IdList |
getQueueIdsForQueueConstrainer(Id queueConstrainerId)
Gets the
Queue Ids mapped to a
QueueConstrainer. |
QueueList |
getQueuesForQueueConstrainer(Id queueConstrainerId)
Gets the
Queues mapped to a QueueConstrainer. |
void |
useComparativeQueueConstrainerRuleView()
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 |
usePlenaryQueueConstrainerRuleView()
A complete view of the
QueueConstrainer 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 canLookupQueueConstrainerRules()
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 useComparativeQueueConstrainerRuleView()
mandatory
- This method is must be implemented. void usePlenaryQueueConstrainerRuleView()
QueueConstrainer
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 getQueueConstrainerIdsForQueue(Id queueId) throws NotFoundException, OperationFailedException, PermissionDeniedException
QueueConstrainer 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. QueueConstrainerList getQueueConstrainersForQueue(Id queueId) throws NotFoundException, OperationFailedException, PermissionDeniedException
QueueConstrainer
associated with a
Queue.
queueId
- Id
of the Queue
NotFoundException
- queueId
is not foundNullArgumentException
- queueId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getQueueIdsForQueueConstrainer(Id queueConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Queue
Ids
mapped to a
QueueConstrainer.
queueConstrainerId
- Id
of a
QueueConstrainer
Ids
NotFoundException
- queueConstrainerId
is not foundNullArgumentException
- queueConstrainerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. QueueList getQueuesForQueueConstrainer(Id queueConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Queues
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.