public interface CanonicalUnitProcessorSearchSession extends CanonicalUnitProcessorQuerySession
This session provides methods for searching among
CanonicalUnitProcessor
objects. The search query is constructed
using the CanonicalUnitProcessoryQuery.
getCanonicalUnitProcessorsByQuery()
is the basic search
method and returns a list of CanonicalUnitProcessors.
A
more advanced search may be performed with
getCanonicalUnitProcessorsBySearch().
It accepts a
CanonicalUnitProcessorSearch
in addition to the query for the
purpose of specifying additional options affecting the entire search, such
as offering. getCanonicalUnitProcessorsBySearch()
returns a
CanonicalUnitProcessorSearchResults
that can be used to
access the resulting CanonicalUnitProcessorList
or be used
to perform a search within the result set through
CanonicalUnitProcessorSearch.
This session defines views that offer differing behaviors for searching.
CanonicalUnitProcessors
may have a query record
indicated by their respective record types. The query record is accessed
via the CanonicalUnitProcessorQuery.
Modifier and Type | Method and Description |
---|---|
CanonicalUnitProcessorQuery |
getCanonicalUnitProcessorQueryFromInspector(CanonicalUnitProcessorQueryInspector canonicalUnitProcessorQueryInspector)
Gets a canonical unit processor query from an inspector.
|
CanonicalUnitProcessorSearchResults |
getCanonicalUnitProcessorsBySearch(CanonicalUnitProcessorQuery canonicalUnitProcessorQuery,
CanonicalUnitProcessorSearch canonicalUnitProcessorSearch)
Gets the search results matching the given search query using the
given search.
|
CanonicalUnitProcessorSearch |
getCanonicalUnitProcessorSearch()
Gets a canonical unit processor search.
|
CanonicalUnitProcessorSearchOrder |
getCanonicalUnitProcessorSearchOrder()
Gets a canonical unit processor search order.
|
canSearchCanonicalUnitProcessors, getCanonicalUnitProcessorQuery, getCanonicalUnitProcessorsByQuery, getCatalogue, getCatalogueId, useFederatedCatalogueView, useIsolatedCatalogueView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
CanonicalUnitProcessorSearch getCanonicalUnitProcessorSearch()
mandatory
- This method must be implemented. CanonicalUnitProcessorSearchOrder getCanonicalUnitProcessorSearchOrder()
CanonicalUnitProcessorSearchOrder
is supplied to a
CanonicalUnitProcessorSearch
to specify the ordering of
results.mandatory
- This method must be implemented. CanonicalUnitProcessorSearchResults getCanonicalUnitProcessorsBySearch(CanonicalUnitProcessorQuery canonicalUnitProcessorQuery, CanonicalUnitProcessorSearch canonicalUnitProcessorSearch) throws OperationFailedException, PermissionDeniedException
canonicalUnitProcessorQuery
- the canonical unit processor querycanonicalUnitProcessorSearch
- the canonical unit processor
searchNullArgumentException
-
canonicalUnitProcessorQuery
or
canonicalUnitProcessorSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
-
canonicalUnitProcessorQuery
or
canonicalUnitProcessorSearch
is not of this servicemandatory
- This method must be implemented. CanonicalUnitProcessorQuery getCanonicalUnitProcessorQueryFromInspector(CanonicalUnitProcessorQueryInspector canonicalUnitProcessorQueryInspector)
CanonicalUnitProcessorSearchResults.
canonicalUnitProcessorQueryInspector
- a canonical unit
processor query inspectorNullArgumentException
-
canonicalUnitProcessorQueryInspector
is null
UnsupportedException
-
canonicalUnitProcessorQueryInspector
is not of this
servicemandatory
- This method must be implemented.