public interface CompositionQuerySession extends OsidSession
This session provides methods for searching among Composition
objects. The search query is constructed using the
CompositionQuery.
This session defines views that offer differing behaviors when searching.
Compositions may have a query record indicated by their respective
record types. The query record is accessed via the
CompositionQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchCompositions()
Tests if this user can perform
Composition searches. |
CompositionQuery |
getCompositionQuery()
Gets a composition query.
|
CompositionList |
getCompositionsByQuery(CompositionQuery compositionQuery)
Gets a list of
Compositions matching the given
composition 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.
|
void |
useSequesteredCompositionView()
The methods in this session omit sequestered compositions.
|
void |
useUnsequesteredCompositionView()
The methods in this session return all compositions, including
sequestered compositions.
|
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 canSearchCompositions()
Composition
searches. 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 opt not to offer search 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. void useSequesteredCompositionView()
mandatory
- This method is must be implemented. void useUnsequesteredCompositionView()
mandatory
- This method is must be implemented. CompositionQuery getCompositionQuery()
mandatory
- This method must be implemented. CompositionList getCompositionsByQuery(CompositionQuery compositionQuery) throws OperationFailedException, PermissionDeniedException
Compositions
matching the given
composition query.compositionQuery
- the composition query CompositionList
NullArgumentException
- compositionQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- compositionQuery
is not of this servicemandatory
- This method must be implemented.