public interface PoolConstrainerSmartDistributorSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
distributors. A PoolConstrainerQuery
can be retrieved from
this session and mapped to this Distributor
to create a
virtual collection of pool constrainers. The pool constrainer may be
sequenced using the PoolConstrainerSearchOrder
from this
session.
This Distributor
has a default query that matches any
pool constrainer and a default search order that specifies no sequencing.
The queries may be examined using a PoolConstrainerQueryInspector.
The query may be modified by converting the inspector back to a
PoolConstrainerQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyPoolConstrainerQuery(PoolConstrainerQuery poolConstrainerQuery)
Applies a pool constrainer query to this distributor.
|
void |
applyPoolConstrainerSequencing(PoolConstrainerSearchOrder poolConstrainerSearchOrder)
Applies a pool 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. |
PoolConstrainerQuery |
getPoolConstrainerQuery()
Gets a pool constrainer query.
|
PoolConstrainerQuery |
getPoolConstrainerQueryFromInspector(PoolConstrainerQueryInspector poolConstrainerQueryInspector)
Gets a pool constrainer query from an inspector.
|
PoolConstrainerSearchOrder |
getPoolConstrainerSearchOrder()
Gets a pool constrainer search order.
|
PoolConstrainerQueryInspector |
inspectPoolConstrainerQuery()
Gets a pool 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. PoolConstrainerQuery getPoolConstrainerQuery()
mandatory
- This method must be implemented. PoolConstrainerSearchOrder getPoolConstrainerSearchOrder()
mandatory
- This method must be implemented. void applyPoolConstrainerQuery(PoolConstrainerQuery poolConstrainerQuery) throws OperationFailedException, PermissionDeniedException
poolConstrainerQuery
- the pool constrainer queryNullArgumentException
- poolConstrainerQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- poolConstrainerQuery
not of this servicemandatory
- This method must be implemented. PoolConstrainerQueryInspector inspectPoolConstrainerQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyPoolConstrainerSequencing(PoolConstrainerSearchOrder poolConstrainerSearchOrder) throws OperationFailedException, PermissionDeniedException
poolConstrainerSearchOrder
- the pool constrainer search orderNullArgumentException
-
poolConstrainerSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
-
poolConstrainerSearchOrder
not of this servicemandatory
- This method must be implemented. PoolConstrainerQuery getPoolConstrainerQueryFromInspector(PoolConstrainerQueryInspector poolConstrainerQueryInspector)
poolConstrainerQueryInspector
- a pool constrainer query
inspectorNullArgumentException
-
poolConstrainerQueryInspector
is null
UnsupportedException
-
poolConstrainerQueryInspector
is not of this servicemandatory
- This method must be implemented.