public interface ProvisionableSmartDistributorSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. A ProvisionableQuery
can be retrieved from this
session and distributorped to this Distributor
to create a
virtual collection of Provisionables.
The provisionables
may be sequenced using the ProvisionableSearchOrder
from
this session.
This Distributor
has a default query that matches any
provisionable and a default search order that specifies no sequencing. The
queries may be examined using a ProvisionableQueryInspector.
The query may be modified by converting the inspector back to a
ProvisionableQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyProvisionableQuery(ProvisionableQuery provisionableQuery)
Applies a provisionable query to this distributor.
|
void |
applyProvisionableSequencing(ProvisionableSearchOrder provisionableSearchOrder)
Applies a provisionable 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. |
ProvisionableQuery |
getProvisionableQuery()
Gets a provisionable query.
|
ProvisionableQuery |
getProvisionableQueryFromInspector(ProvisionableQueryInspector provisionableQueryInspector)
Gets a provisionable query from an inspector.
|
ProvisionableSearchOrder |
getProvisionableSearchOrder()
Gets a provisionable search order.
|
ProvisionableQueryInspector |
inspectProvisionableQuery()
Gets a provisionable 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. ProvisionableQuery getProvisionableQuery()
mandatory
- This method must be implemented. ProvisionableSearchOrder getProvisionableSearchOrder()
mandatory
- This method must be implemented. void applyProvisionableQuery(ProvisionableQuery provisionableQuery) throws OperationFailedException, PermissionDeniedException
provisionableQuery
- the provisionable queryNullArgumentException
- provisionableQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- provisionableQuery
not of this servicemandatory
- This method must be implemented. ProvisionableQueryInspector inspectProvisionableQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyProvisionableSequencing(ProvisionableSearchOrder provisionableSearchOrder) throws OperationFailedException, PermissionDeniedException
provisionableSearchOrder
- the provisionable search orderNullArgumentException
- provisionableSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- provisionableSearchOrder
not of this servicemandatory
- This method must be implemented. ProvisionableQuery getProvisionableQueryFromInspector(ProvisionableQueryInspector provisionableQueryInspector)
provisionableQueryInspector
- a provisionable query inspectorNullArgumentException
-
provisionableQueryInspector
is null
UnsupportedException
-
provisionableQueryInspector
is not of this servicemandatory
- This method must be implemented.