public interface CompositionSearchSession extends CompositionQuerySession
This session provides methods for searching among Composition
objects. The search query is constructed using the
CompositionQuery.
getCompositionsByQuery()
is the basic search method and
returns a list of Compositions.
A more advanced search may
be performed with getCompositionsBySearch().
It accepts an
Composition
in addition to the query for the purpose of
specifying additional options affecting the entire search, such as
ordering. getCompositionsBySearch()
returns an
CompositionSearchResults
that can be used to access the resulting
Composition
or be used to perform a search within the
result set through CompositionSearch.
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 |
---|---|
CompositionQuery |
getCompositionQueryFromInspector(CompositionQueryInspector compositionQueryInspector)
Gets a composition query from an inspector.
|
CompositionSearchResults |
getCompositionsBySearch(CompositionQuery compositionQuery,
CompositionSearch compositionSearch)
Gets the search results matching the given search query using the
given search.
|
CompositionSearch |
getCompositionSearch()
Gets a composition search.
|
CompositionSearchOrder |
getCompositionSearchOrder()
Gets a composition search order.
|
canSearchCompositions, getCompositionQuery, getCompositionsByQuery, getRepository, getRepositoryId, useFederatedRepositoryView, useIsolatedRepositoryView, useSequesteredCompositionView, useUnsequesteredCompositionView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
CompositionSearch getCompositionSearch()
mandatory
- This method must be implemented. CompositionSearchOrder getCompositionSearchOrder()
CompositionSearchOrder
is supplied to an CompositionSearch
to specify
the ordering of results.mandatory
- This method must be implemented. CompositionSearchResults getCompositionsBySearch(CompositionQuery compositionQuery, CompositionSearch compositionSearch) throws OperationFailedException, PermissionDeniedException
compositionQuery
- the composition querycompositionSearch
- the composition searchNullArgumentException
- compositionQuery
or compositionSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- compositionQuery
or compositionSearch
is not of this servicemandatory
- This method must be implemented. CompositionQuery getCompositionQueryFromInspector(CompositionQueryInspector compositionQueryInspector)
CompositionSearchResults.
compositionQueryInspector
- a composition query inspectorNullArgumentException
-
compositionQueryInspector
is null
UnsupportedException
- compositionQueryInspector
is not of this servicemandatory
- This method must be implemented.