public interface ProvisionSmartDistributorSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. A ProvisionQuery
can be retrieved from this
session and distributorped to this Distributor
to create a
virtual collection of Provisions.
The provisions may be
sequenced using the ProvisionSearchOrder
from this session.
This Distributor
has a default query that matches any
provision and a default search order that specifies no sequencing. The
queries may be examined using a ProvisionQueryInspector.
The query may be modified by converting the inspector back to a
ProvisionQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyProvisionQuery(ProvisionQuery provisionQuery)
Applies a provision query to this distributor.
|
void |
applyProvisionSequencing(ProvisionSearchOrder provisionSearchOrder)
Applies a provision 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. |
ProvisionQuery |
getProvisionQuery()
Gets a provision query.
|
ProvisionQuery |
getProvisionQueryFromInspector(ProvisionQueryInspector provisionQueryInspector)
Gets a provision query from an inspector.
|
ProvisionSearchOrder |
getProvisionSearchOrder()
Gets a provision search order.
|
ProvisionQueryInspector |
inspectProvisionQuery()
Gets a provision 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. ProvisionQuery getProvisionQuery()
mandatory
- This method must be implemented. ProvisionSearchOrder getProvisionSearchOrder()
mandatory
- This method must be implemented. void applyProvisionQuery(ProvisionQuery provisionQuery) throws OperationFailedException, PermissionDeniedException
provisionQuery
- the provision queryNullArgumentException
- provisionQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- provisionQuery
not of this servicemandatory
- This method must be implemented. ProvisionQueryInspector inspectProvisionQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyProvisionSequencing(ProvisionSearchOrder provisionSearchOrder) throws OperationFailedException, PermissionDeniedException
provisionSearchOrder
- the provision search orderNullArgumentException
- provisionSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- provisionSearchOrder
not of this servicemandatory
- This method must be implemented. ProvisionQuery getProvisionQueryFromInspector(ProvisionQueryInspector provisionQueryInspector)
provisionQueryInspector
- a provision query inspectorNullArgumentException
- provisionQueryInspector
is null
UnsupportedException
- provisionQueryInspector
is not of this servicemandatory
- This method must be implemented.