public interface PoolProcessorEnablerSmartDistributorSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
distributors. A PoolProcessorEnablerQuery
can be retrieved
from this session and mapped to this Distributor
to create
a virtual collection of pool processor enablers. The pool processor
enablers may be sequenced using the PoolProcessorEnablerSearchOrder
from this session.
This Distributor
has a default query that matches any
pool processor enabler and a default search order that specifies no
sequencing. The queries may be examined using a
PoolProcessorEnablerQueryInspector.
The query may be modified by
converting the inspector back to a PoolProcessorEnablerQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyPoolProcessorEnablerQuery(PoolProcessorEnablerQuery poolProcessorEnablerQuery)
Applies a pool processor enabler query to this distributor.
|
void |
applyPoolProcessorEnablerSequencing(PoolProcessorEnablerSearchOrder poolProcessorEnablerSearchOrder)
Applies a pool processor 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. |
PoolProcessorEnablerQuery |
getPoolProcessorEnablerQuery()
Gets a pool processor enabler query.
|
PoolProcessorEnablerQuery |
getPoolProcessorEnablerQueryFromInspector(PoolProcessorEnablerQueryInspector poolProcessorEnablerQueryInspector)
Gets a pool processor enabler query from an inspector.
|
PoolProcessorEnablerSearchOrder |
getPoolProcessorEnablerSearchOrder()
Gets a pool processor enabler search order.
|
PoolProcessorEnablerQueryInspector |
inspectPoolProcessorEnablerQuery()
Gets a pool processor 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. PoolProcessorEnablerQuery getPoolProcessorEnablerQuery()
mandatory
- This method must be implemented. PoolProcessorEnablerSearchOrder getPoolProcessorEnablerSearchOrder()
mandatory
- This method must be implemented. void applyPoolProcessorEnablerQuery(PoolProcessorEnablerQuery poolProcessorEnablerQuery) throws OperationFailedException, PermissionDeniedException
poolProcessorEnablerQuery
- the pool processor enabler queryNullArgumentException
-
poolProcessorEnablerQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- poolProcessorEnablerQuery
not of this servicemandatory
- This method must be implemented. PoolProcessorEnablerQueryInspector inspectPoolProcessorEnablerQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyPoolProcessorEnablerSequencing(PoolProcessorEnablerSearchOrder poolProcessorEnablerSearchOrder) throws OperationFailedException, PermissionDeniedException
poolProcessorEnablerSearchOrder
- the pool processor enabler
search orderNullArgumentException
-
poolProcessorEnablerSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
-
poolProcessorEnablerSearchOrder
not of this servicemandatory
- This method must be implemented. PoolProcessorEnablerQuery getPoolProcessorEnablerQueryFromInspector(PoolProcessorEnablerQueryInspector poolProcessorEnablerQueryInspector)
poolProcessorEnablerQueryInspector
- a pool processor enabler
query inspectorNullArgumentException
-
poolProcessorEnablerQueryInspector
is null
UnsupportedException
-
poolProcessorEnablerQueryInspector
is not of this
servicemandatory
- This method must be implemented.