public interface PoolProcessorSmartDistributorSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
distributors. A PoolProcessorQuery
can be retrieved from
this session and mapped to this Distributor
to create a
virtual collection of pool processors. The pool processor may be sequenced
using the PoolProcessorSearchOrder
from this session.
This Distributor
has a default query that matches any
pool processor and a default search order that specifies no sequencing.
The queries may be examined using a PoolProcessorQueryInspector.
The query may be modified by converting the inspector back to a
PoolProcessorQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyPoolProcessorQuery(PoolProcessorQuery poolProcessorQuery)
Applies a pool processor query to this distributor.
|
void |
applyPoolProcessorSequencing(PoolProcessorSearchOrder poolProcessorSearchOrder)
Applies a pool processor 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. |
PoolProcessorQuery |
getPoolProcessorQuery()
Gets a pool processor query.
|
PoolProcessorQuery |
getPoolProcessorQueryFromInspector(PoolProcessorQueryInspector poolProcessorQueryInspector)
Gets a pool processor query from an inspector.
|
PoolProcessorSearchOrder |
getPoolProcessorSearchOrder()
Gets a pool processor search order.
|
PoolProcessorQueryInspector |
inspectPoolProcessorQuery()
Gets a pool processor 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. PoolProcessorQuery getPoolProcessorQuery()
mandatory
- This method must be implemented. PoolProcessorSearchOrder getPoolProcessorSearchOrder()
mandatory
- This method must be implemented. void applyPoolProcessorQuery(PoolProcessorQuery poolProcessorQuery) throws OperationFailedException, PermissionDeniedException
poolProcessorQuery
- the pool processor queryNullArgumentException
- poolProcessorQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- poolProcessorQuery
not of this servicemandatory
- This method must be implemented. PoolProcessorQueryInspector inspectPoolProcessorQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyPoolProcessorSequencing(PoolProcessorSearchOrder poolProcessorSearchOrder) throws OperationFailedException, PermissionDeniedException
poolProcessorSearchOrder
- the pool processor search orderNullArgumentException
- poolProcessorSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- poolProcessorSearchOrder
not of this servicemandatory
- This method must be implemented. PoolProcessorQuery getPoolProcessorQueryFromInspector(PoolProcessorQueryInspector poolProcessorQueryInspector)
poolProcessorQueryInspector
- a pool processor query inspectorNullArgumentException
-
poolProcessorQueryInspector
is null
UnsupportedException
-
poolProcessorQueryInspector
is not of this servicemandatory
- This method must be implemented.