public interface CompositionEnablerSmartRepositorySession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
repositories. A CompositionEnablerQuery
can be retrieved
from this session and mapped to this Repository
to create a
virtual collection of composition enablers. The composition enablers may
be sequenced using the CompositionEnablerSearchOrder
from
this session.
This Repository
has a default query that matches any
composition enabler and a default search order that specifies no
sequencing. The queries may be examined using a
CompositionEnablerQueryInspector.
The query may be modified by
converting the inspector back to a CompositionEnablerQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyCompositionEnablerQuery(CompositionEnablerQuery compositionEnablerQuery)
Applies a composition enabler query to this repository.
|
void |
applyCompositionEnablerSequencing(CompositionEnablerSearchOrder compositionEnablerSearchOrder)
Applies a composition enabler search order to this repository.
|
boolean |
canManageSmartRepositories()
Tests if this user can manage smart repositories.
|
CompositionEnablerQuery |
getCompositionEnablerQuery()
Gets a composition enabler query.
|
CompositionEnablerQuery |
getCompositionEnablerQueryFromInspector(CompositionEnablerQueryInspector compositionEnablerQueryInspector)
Gets a composition enabler query from an inspector.
|
CompositionEnablerSearchOrder |
getCompositionEnablerSearchOrder()
Gets a composition enabler search order.
|
Repository |
getRepository()
Gets the
Repository associated with this session. |
Id |
getRepositoryId()
Gets the
Repository Id associated with
this session. |
CompositionEnablerQueryInspector |
inspectCompositionEnablerQuery()
Gets a composition enabler 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.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canManageSmartRepositories()
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. CompositionEnablerQuery getCompositionEnablerQuery()
mandatory
- This method must be implemented. CompositionEnablerSearchOrder getCompositionEnablerSearchOrder()
mandatory
- This method must be implemented. void applyCompositionEnablerQuery(CompositionEnablerQuery compositionEnablerQuery) throws OperationFailedException, PermissionDeniedException
compositionEnablerQuery
- the composition enabler queryNullArgumentException
- compositionEnablerQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- compositionEnablerQuery
not of this servicemandatory
- This method must be implemented. CompositionEnablerQueryInspector inspectCompositionEnablerQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyCompositionEnablerSequencing(CompositionEnablerSearchOrder compositionEnablerSearchOrder) throws OperationFailedException, PermissionDeniedException
compositionEnablerSearchOrder
- the composition enabler search
orderNullArgumentException
-
compositionEnablerSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
-
compositionEnablerSearchOrder
not of this servicemandatory
- This method must be implemented. CompositionEnablerQuery getCompositionEnablerQueryFromInspector(CompositionEnablerQueryInspector compositionEnablerQueryInspector)
compositionEnablerQueryInspector
- a composition enabler query
inspectorNullArgumentException
-
compositionEnablerQueryInspector
is null
UnsupportedException
-
compositionEnablerQueryInspector
is not of this
servicemandatory
- This method must be implemented.