public interface QueueConstrainerSmartDistributorSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
distributors. a QueueConstrainerQuery
can be retrieved from
this session and mapped to this Distributor
to create a
virtual collection of queue constrainers. The queue constrainer may be
sequenced using the QueueConstrainerSearchOrder
from this
session.
This Distributor
has a default query that matches any
queue constrainer and a default search order that specifies no sequencing.
The queries may be examined using a QueueConstrainerQueryInspector.
The query may be modified by converting the inspector back to a
QueueConstrainerQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyQueueConstrainerQuery(QueueConstrainerQuery queueConstrainerQuery)
Applies a queue constrainer query to this distributor.
|
void |
applyQueueConstrainerSequencing(QueueConstrainerSearchOrder queueConstrainerSearchOrder)
Applies a queue constrainer search order to this distributor.
|
boolean |
canManageSmartDistributors()
Tests if this user can manage smart distributors.
|
Distributor |
getDistributor()
Gets the
Distributor associated with this session. |
Id |
getDistributorId()
Gets the
Distributor Id associated with
this session. |
QueueConstrainerQuery |
getQueueConstrainerQuery()
Gets a queue constrainer query.
|
QueueConstrainerQuery |
getQueueConstrainerQueryFromInspector(QueueConstrainerQueryInspector queueConstrainerQueryInspector)
Gets a queue constrainer query from an inspector.
|
QueueConstrainerSearchOrder |
getQueueConstrainerSearchOrder()
Gets a queue constrainer search order.
|
QueueConstrainerQueryInspector |
inspectQueueConstrainerQuery()
Gets a queue constrainer query inspector for this distributor.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getDistributorId()
Distributor
Id
associated with
this session. Distributor Id
associated with this sessionmandatory
- This method must be implemented. Distributor getDistributor() throws OperationFailedException, PermissionDeniedException
Distributor
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canManageSmartDistributors()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer operations to unauthorized
users. false
if smart distributor management is not
authorized, true
otherwisemandatory
- This method must be implemented. QueueConstrainerQuery getQueueConstrainerQuery()
mandatory
- This method must be implemented. QueueConstrainerSearchOrder getQueueConstrainerSearchOrder()
mandatory
- This method must be implemented. void applyQueueConstrainerQuery(QueueConstrainerQuery queueConstrainerQuery) throws OperationFailedException, PermissionDeniedException
queueConstrainerQuery
- the queue constrainer queryNullArgumentException
- queueConstrainerQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- queueConstrainerQuery
not of this servicemandatory
- This method must be implemented. QueueConstrainerQueryInspector inspectQueueConstrainerQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyQueueConstrainerSequencing(QueueConstrainerSearchOrder queueConstrainerSearchOrder) throws OperationFailedException, PermissionDeniedException
queueConstrainerSearchOrder
- the queue constrainer search orderNullArgumentException
-
queueConstrainerSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
-
queueConstrainerSearchOrder
not of this servicemandatory
- This method must be implemented. QueueConstrainerQuery getQueueConstrainerQueryFromInspector(QueueConstrainerQueryInspector queueConstrainerQueryInspector)
queueConstrainerQueryInspector
- a queue constrainer query
inspectorNullArgumentException
-
queueConstrainerQueryInspector
is null
UnsupportedException
-
queueConstrainerQueryInspector
is not of this servicemandatory
- This method must be implemented.