public interface CompositionSmartRepositorySession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. A CompositionQuery
can be retrieved from this
session and mapped to this Repository
to create a virtual
collection of Compositions.
The compositions may be
sequenced using the CompositionSearchOrder
from this
session.
This Repository
has a default query that matches any
composition and a default search order that specifies no sequencing. The
queries may be examined using a CompositionQueryInspector.
The query may be modified by converting the inspector back to a
CompositionQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyCompositionQuery(CompositionQuery compositionQuery)
Applies a composition query to this repository.
|
void |
applyCompositionSequencing(CompositionSearchOrder compositionSearchOrder)
Applies a composition search order to this repository.
|
boolean |
canManageSmartRepository()
Tests if this user can manage smart repository.
|
CompositionQuery |
getCompositionQuery()
Gets a composition query.
|
CompositionQuery |
getCompositionQueryFromInspector(CompositionQueryInspector compositionQueryInspector)
Gets a composition query from an inspector.
|
CompositionSearchOrder |
getCompositionSearchOrder()
Gets a composition search order.
|
Repository |
getRepository()
Gets the
Repository associated with this session. |
Id |
getRepositoryId()
Gets the
Repository Id associated with
this session. |
CompositionQueryInspector |
inspectCompositionQuery()
Gets a composition query inspector for this repository.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getRepositoryId()
Repository
Id
associated with
this session. Repository Id
associated with this sessionmandatory
- This method must be implemented. Repository getRepository() throws OperationFailedException, PermissionDeniedException
Repository
associated with this session. Repository
associated with this sessionOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canManageSmartRepository()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer operations to unauthorized
users. false
if smart repository management is not
authorized, true
otherwisemandatory
- This method must be implemented. CompositionQuery getCompositionQuery()
mandatory
- This method must be implemented. CompositionSearchOrder getCompositionSearchOrder()
mandatory
- This method must be implemented. void applyCompositionQuery(CompositionQuery compositionQuery) throws OperationFailedException, PermissionDeniedException
compositionQuery
- the composition queryNullArgumentException
- compositionQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- compositionQuery
not of this servicemandatory
- This method must be implemented. CompositionQueryInspector inspectCompositionQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyCompositionSequencing(CompositionSearchOrder compositionSearchOrder) throws OperationFailedException, PermissionDeniedException
compositionSearchOrder
- the composition search orderNullArgumentException
- compositionSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- compositionSearchOrder
not of this servicemandatory
- This method must be implemented. CompositionQuery getCompositionQueryFromInspector(CompositionQueryInspector compositionQueryInspector)
compositionQueryInspector
- a resorce relationship query
inspectorNullArgumentException
-
compositionQueryInspector
is null
UnsupportedException
- compositionQueryInspector
is not of this servicemandatory
- This method must be implemented.