public interface PoolConstrainerEnablerSmartDistributorSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
distributors. A PoolConstrainerEnablerQuery
can be
retrieved from this session and mapped to this Distributor
to create a virtual collection of pool constrainer enablers. The pool
constrainer enablers may be sequenced using the
PoolConstrainerEnablerSearchOrder
from this session.
This Distributor
has a default query that matches any
pool constrainer enabler and a default search order that specifies no
sequencing. The queries may be examined using a
PoolConstrainerEnablerQueryInspector.
The query may be modified by
converting the inspector back to a PoolConstrainerEnablerQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyPoolConstrainerEnablerQuery(PoolConstrainerEnablerQuery poolConstrainerEnablerQuery)
Applies a pool constrainer enabler query to this distributor.
|
void |
applyPoolConstrainerEnablerSequencing(PoolConstrainerEnablerSearchOrder poolConstrainerEnablerSearchOrder)
Applies a pool 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. |
PoolConstrainerEnablerQuery |
getPoolConstrainerEnablerQuery()
Gets a pool constrainer enabler query.
|
PoolConstrainerEnablerQuery |
getPoolConstrainerEnablerQueryFromInspector(PoolConstrainerEnablerQueryInspector poolConstrainerEnablerQueryInspector)
Gets a pool constrainer enabler query from an inspector.
|
PoolConstrainerEnablerSearchOrder |
getPoolConstrainerEnablerSearchOrder()
Gets a pool constrainer enabler search order.
|
PoolConstrainerEnablerQueryInspector |
inspectPoolConstrainerEnablerQuery()
Gets a pool 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. PoolConstrainerEnablerQuery getPoolConstrainerEnablerQuery()
mandatory
- This method must be implemented. PoolConstrainerEnablerSearchOrder getPoolConstrainerEnablerSearchOrder()
mandatory
- This method must be implemented. void applyPoolConstrainerEnablerQuery(PoolConstrainerEnablerQuery poolConstrainerEnablerQuery) throws OperationFailedException, PermissionDeniedException
poolConstrainerEnablerQuery
- the pool constrainer enabler queryNullArgumentException
-
poolConstrainerEnablerQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
-
poolConstrainerEnablerQuery
not of this servicemandatory
- This method must be implemented. PoolConstrainerEnablerQueryInspector inspectPoolConstrainerEnablerQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyPoolConstrainerEnablerSequencing(PoolConstrainerEnablerSearchOrder poolConstrainerEnablerSearchOrder) throws OperationFailedException, PermissionDeniedException
poolConstrainerEnablerSearchOrder
- the pool constrainer enabler
search orderNullArgumentException
-
poolConstrainerEnablerSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
-
poolConstrainerEnablerSearchOrder
not of this servicemandatory
- This method must be implemented. PoolConstrainerEnablerQuery getPoolConstrainerEnablerQueryFromInspector(PoolConstrainerEnablerQueryInspector poolConstrainerEnablerQueryInspector)
poolConstrainerEnablerQueryInspector
- a pool constrainer
enabler query inspectorNullArgumentException
-
poolConstrainerEnablerQueryInspector
is null
UnsupportedException
-
poolConstrainerEnablerQueryInspector
is not of this
servicemandatory
- This method must be implemented.