public interface QueueConstrainerEnablerSmartDistributorSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
distributors. a QueueConstrainerEnablerQuery
can be
retrieved from this session and mapped to this Distributor
to create a virtual collection of queue constrainer enablers. The queue
constrainer enablers may be sequenced using the
QueueConstrainerEnablerSearchOrder
from this session.
This Distributor
has a default query that matches any
queue constrainer enabler and a default search order that specifies no
sequencing. The queries may be examined using a
QueueConstrainerEnablerQueryInspector.
The query may be modified
by converting the inspector back to a QueueConstrainerEnablerQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyQueueConstrainerEnablerQuery(QueueConstrainerEnablerQuery queueConstrainerEnablerQuery)
Applies a queue constrainer enabler query to this distributor.
|
void |
applyQueueConstrainerEnablerSequencing(QueueConstrainerEnablerSearchOrder queueConstrainerEnablerSearchOrder)
Applies a queue constrainer enabler 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. |
QueueConstrainerEnablerQuery |
getQueueConstrainerEnablerQuery()
Gets a queue constrainer enabler query.
|
QueueConstrainerEnablerQuery |
getQueueConstrainerEnablerQueryFromInspector(QueueConstrainerEnablerQueryInspector queueConstrainerEnablerQueryInspector)
Gets a queue constrainer enabler query from an inspector.
|
QueueConstrainerEnablerSearchOrder |
getQueueConstrainerEnablerSearchOrder()
Gets a queue constrainer enabler search order.
|
QueueConstrainerEnablerQueryInspector |
inspectQueueConstrainerEnablerQuery()
Gets a queue constrainer enabler 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. QueueConstrainerEnablerQuery getQueueConstrainerEnablerQuery()
mandatory
- This method must be implemented. QueueConstrainerEnablerSearchOrder getQueueConstrainerEnablerSearchOrder()
mandatory
- This method must be implemented. void applyQueueConstrainerEnablerQuery(QueueConstrainerEnablerQuery queueConstrainerEnablerQuery) throws OperationFailedException, PermissionDeniedException
queueConstrainerEnablerQuery
- the queue constrainer enabler
queryNullArgumentException
-
queueConstrainerEnablerQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
-
queueConstrainerEnablerQuery
not of this servicemandatory
- This method must be implemented. QueueConstrainerEnablerQueryInspector inspectQueueConstrainerEnablerQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyQueueConstrainerEnablerSequencing(QueueConstrainerEnablerSearchOrder queueConstrainerEnablerSearchOrder) throws OperationFailedException, PermissionDeniedException
queueConstrainerEnablerSearchOrder
- the queue constrainer
enabler search orderNullArgumentException
-
queueConstrainerEnablerSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
-
queueConstrainerEnablerSearchOrder
not of this servicemandatory
- This method must be implemented. QueueConstrainerEnablerQuery getQueueConstrainerEnablerQueryFromInspector(QueueConstrainerEnablerQueryInspector queueConstrainerEnablerQueryInspector)
queueConstrainerEnablerQueryInspector
- a queue constrainer
enabler query inspectorNullArgumentException
-
queueConstrainerEnablerQueryInspector
is null
UnsupportedException
-
queueConstrainerEnablerQueryInspector
is not of this
servicemandatory
- This method must be implemented.