public interface RequestSmartDistributorSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. A RequestQuery
can be retrieved from this session
and distributorped to this Distributor
to create a virtual
collection of Requests.
The requests may be sequenced using
the RequestSearchOrder
from this session.
This Distributor
has a default query that matches any
request and a default search order that specifies no sequencing. The
queries may be examined using a RequestQueryInspector.
The
query may be modified by converting the inspector back to a
RequestQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyRequestQuery(RequestQuery requestQuery)
Applies a request query to this distributor.
|
void |
applyRequestSequencing(RequestSearchOrder requestSearchOrder)
Applies a request 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. |
RequestQuery |
getRequestQuery()
Gets a request query.
|
RequestQuery |
getRequestQueryFromInspector(RequestQueryInspector requestQueryInspector)
Gets a request query from an inspector.
|
RequestSearchOrder |
getRequestSearchOrder()
Gets a request search order.
|
RequestQueryInspector |
inspectRequestQuery()
Gets a request 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. RequestQuery getRequestQuery()
mandatory
- This method must be implemented. RequestSearchOrder getRequestSearchOrder()
mandatory
- This method must be implemented. void applyRequestQuery(RequestQuery requestQuery) throws OperationFailedException, PermissionDeniedException
requestQuery
- the request queryNullArgumentException
- requestQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- requestQuery
not
of this servicemandatory
- This method must be implemented. RequestQueryInspector inspectRequestQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyRequestSequencing(RequestSearchOrder requestSearchOrder) throws OperationFailedException, PermissionDeniedException
requestSearchOrder
- the request search orderNullArgumentException
- requestSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- requestSearchOrder
not of this servicemandatory
- This method must be implemented. RequestQuery getRequestQueryFromInspector(RequestQueryInspector requestQueryInspector)
requestQueryInspector
- a request query inspectorNullArgumentException
- requestQueryInspector
is null
UnsupportedException
- requestQueryInspector
is not of this servicemandatory
- This method must be implemented.