public interface PoolSmartDistributorSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. A PoolQuery
can be retrieved from this session
and distributorped to this Distributor
to create a virtual
collection of Pools.
The pools may be sequenced using the
PoolSearchOrder
from this session.
This Distributor
has a default query that matches any
pool and a default search order that specifies no sequencing. The queries
may be examined using a PoolQueryInspector.
The query may
be modified by converting the inspector back to a PoolQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyPoolQuery(PoolQuery poolQuery)
Applies a pool query to this distributor.
|
void |
applyPoolSequencing(PoolSearchOrder poolSearchOrder)
Applies a pool 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. |
PoolQuery |
getPoolQuery()
Gets a pool query.
|
PoolQuery |
getPoolQueryFromInspector(PoolQueryInspector poolQueryInspector)
Gets a pool query from an inspector.
|
PoolSearchOrder |
getPoolSearchOrder()
Gets a pool search order.
|
PoolQueryInspector |
inspectPoolQuery()
Gets a pool 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. PoolQuery getPoolQuery()
mandatory
- This method must be implemented. PoolSearchOrder getPoolSearchOrder()
mandatory
- This method must be implemented. void applyPoolQuery(PoolQuery poolQuery) throws OperationFailedException, PermissionDeniedException
poolQuery
- the pool queryNullArgumentException
- poolQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- poolQuery
not of
this servicemandatory
- This method must be implemented. PoolQueryInspector inspectPoolQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyPoolSequencing(PoolSearchOrder poolSearchOrder) throws OperationFailedException, PermissionDeniedException
poolSearchOrder
- the pool search orderNullArgumentException
- poolSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- poolSearchOrder
not of this servicemandatory
- This method must be implemented. PoolQuery getPoolQueryFromInspector(PoolQueryInspector poolQueryInspector)
poolQueryInspector
- a pool query inspectorNullArgumentException
- poolQueryInspector
is null
UnsupportedException
- poolQueryInspector
is not of this servicemandatory
- This method must be implemented.