public interface CanonicalUnitEnablerSearchSession extends CanonicalUnitEnablerQuerySession
This session provides methods for searching among
CanonicalUnitEnabler
objects. The search query is constructed
using the CanonicalUnitEnableryQuery.
getCanonicalUnitEnablersByQuery()
is the basic search
method and returns a list of CanonicalUnitEnablers.
A more
advanced search may be performed with
getCanonicalUnitEnablersBySearch().
It accepts a
CanonicalUnitEnablerSearch
in addition to the query for the
purpose of specifying additional options affecting the entire search, such
as offering. getCanonicalUnitEnablersBySearch()
returns a
CanonicalUnitEnablerSearchResults
that can be used to
access the resulting CanonicalUnitEnablerList
or be used to
perform a search within the result set through
CanonicalUnitEnablerSearch.
This session defines views that offer differing behaviors for searching.
CanonicalUnitEnablers
may have a query record indicated
by their respective record types. The query record is accessed via the
CanonicalUnitEnablerQuery.
Modifier and Type | Method and Description |
---|---|
CanonicalUnitEnablerQuery |
getCanonicalUnitEnablerQueryFromInspector(CanonicalUnitEnablerQueryInspector canonicalUnitEnablerQueryInspector)
Gets a canonical unit enabler query from an inspector.
|
CanonicalUnitEnablerSearchResults |
getCanonicalUnitEnablersBySearch(CanonicalUnitEnablerQuery canonicalUnitEnablerQuery,
CanonicalUnitEnablerSearch canonicalUnitEnablerSearch)
Gets the search results matching the given search query using the
given search.
|
CanonicalUnitEnablerSearch |
getCanonicalUnitEnablerSearch()
Gets a canonical unit enabler search.
|
CanonicalUnitEnablerSearchOrder |
getCanonicalUnitEnablerSearchOrder()
Gets a canonical unit enabler search order.
|
canSearchCanonicalUnitEnablers, getCanonicalUnitEnablerQuery, getCanonicalUnitEnablersByQuery, getCatalogue, getCatalogueId, useFederatedCatalogueView, useIsolatedCatalogueView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
CanonicalUnitEnablerSearch getCanonicalUnitEnablerSearch()
mandatory
- This method must be implemented. CanonicalUnitEnablerSearchOrder getCanonicalUnitEnablerSearchOrder()
CanonicalUnitEnablerSearchOrder
is supplied to a
CanonicalUnitEnablerSearch
to specify the ordering of results.mandatory
- This method must be implemented. CanonicalUnitEnablerSearchResults getCanonicalUnitEnablersBySearch(CanonicalUnitEnablerQuery canonicalUnitEnablerQuery, CanonicalUnitEnablerSearch canonicalUnitEnablerSearch) throws OperationFailedException, PermissionDeniedException
canonicalUnitEnablerQuery
- the canonical unit enabler querycanonicalUnitEnablerSearch
- the canonical unit enabler searchNullArgumentException
-
canonicalUnitEnablerQuery
or
canonicalUnitEnablerSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- canonicalUnitEnablerQuery
or canonicalUnitEnablerSearch
is not of
this servicemandatory
- This method must be implemented. CanonicalUnitEnablerQuery getCanonicalUnitEnablerQueryFromInspector(CanonicalUnitEnablerQueryInspector canonicalUnitEnablerQueryInspector)
CanonicalUnitEnablerSearchResults.
canonicalUnitEnablerQueryInspector
- a canonical unit enabler
query inspectorNullArgumentException
-
canonicalUnitEnablerQueryInspector
is null
UnsupportedException
-
canonicalUnitEnablerQueryInspector
is not of this
servicemandatory
- This method must be implemented.