public interface CompositionEnablerQuerySession extends OsidSession
This session provides methods for searching among
CompositionEnabler
objects. The search query is constructed using
the CompositionEnablerQuery.
This session defines views that offer differing behaviors for searching.
Composition enablers may have a query record indicated by their
respective record types. The query record is accessed via the
CompositionEnablerQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchCompositionEnablers()
Tests if this user can perform
CompositionEnabler
lookups. |
CompositionEnablerQuery |
getCompositionEnablerQuery()
Gets a composition enabler query.
|
CompositionEnablerList |
getCompositionEnablersByQuery(CompositionEnablerQuery compositionEnablerQuery)
Gets a list of
CompositionEnablers matching the given
composition enabler query. |
Repository |
getRepository()
Gets the
Repository associated with this session. |
Id |
getRepositoryId()
Gets the
Repository Id associated with
this session. |
void |
useFederatedRepositoryView()
Federates the view for methods in this session.
|
void |
useIsolatedRepositoryView()
Isolates the view for methods in this session.
|
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 canSearchCompositionEnablers()
CompositionEnabler
lookups. A return of true does not guarantee successful authorization.
A return of false indicates that it is known all methods in this
session will result in a PERMISSION_DENIED.
This is
intended as a hint to an application that may not offer lookup
operations to unauthorized users. false
if search methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useFederatedRepositoryView()
mandatory
- This method is must be implemented. void useIsolatedRepositoryView()
mandatory
- This method is must be implemented. CompositionEnablerQuery getCompositionEnablerQuery()
mandatory
- This method must be implemented. CompositionEnablerList getCompositionEnablersByQuery(CompositionEnablerQuery compositionEnablerQuery) throws OperationFailedException, PermissionDeniedException
CompositionEnablers
matching the given
composition enabler query.compositionEnablerQuery
- the composition enabler query CompositionEnablerList
NullArgumentException
- compositionEnablerQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- compositionEnablerQuery
is not of this servicemandatory
- This method must be implemented.