public interface ChainSmartAntimatroidSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. A ChainQuery
can be retrieved from this session
and antimatroidped to this Antimatroid
to create a virtual
collection of Chains.
The chains may be sequenced using the
ChainSearchOrder
from this session.
This Antimatroid
has a default query that matches any
chain and a default search order that specifies no sequencing. The queries
may be examined using a ChainQueryInspector.
The query may
be modified by converting the inspector back to a ChainQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyChainQuery(ChainQuery chainQuery)
Applies a chain query to this antimatroid.
|
void |
applyChainSequencing(ChainSearchOrder chainSearchOrder)
Applies a chain search order to this antimatroid.
|
boolean |
canManageSmartAntimatroids()
Tests if this user can manage smart antimatroids.
|
Antimatroid |
getAntimatroid()
Gets the
Antimatroid associated with this session. |
Id |
getAntimatroidId()
Gets the
Antimatroid Id associated with
this session. |
ChainQuery |
getChainQuery()
Gets a chain query.
|
ChainQuery |
getChainQueryFromInspector(ChainQueryInspector chainQueryInspector)
Gets a chain query from an inspector.
|
ChainSearchOrder |
getChainSearchOrder()
Gets a chain search order.
|
ChainQueryInspector |
inspectChainQuery()
Gets a chain query inspector for this antimatroid.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getAntimatroidId()
Antimatroid
Id
associated with
this session. Antimatroid Id
associated with this sessionmandatory
- This method must be implemented. Antimatroid getAntimatroid() throws OperationFailedException, PermissionDeniedException
Antimatroid
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canManageSmartAntimatroids()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer operations to unauthorized
users. false
if smart antimatroid management is not
authorized, true
otherwisemandatory
- This method must be implemented. ChainQuery getChainQuery()
mandatory
- This method must be implemented. ChainSearchOrder getChainSearchOrder()
mandatory
- This method must be implemented. void applyChainQuery(ChainQuery chainQuery) throws OperationFailedException, PermissionDeniedException
chainQuery
- the chain queryNullArgumentException
- chainQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- chainQuery
not of
this servicemandatory
- This method must be implemented. ChainQueryInspector inspectChainQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyChainSequencing(ChainSearchOrder chainSearchOrder) throws OperationFailedException, PermissionDeniedException
chainSearchOrder
- the chain search orderNullArgumentException
- chainSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- chainSearchOrder
not of this servicemandatory
- This method must be implemented. ChainQuery getChainQueryFromInspector(ChainQueryInspector chainQueryInspector)
chainQueryInspector
- a chain query inspectorNullArgumentException
- chainQueryInspector
is null
UnsupportedException
- chainQueryInspector
is not of this servicemandatory
- This method must be implemented.