public interface OfferingConstrainerEnablerSearchSession extends OfferingConstrainerEnablerQuerySession
This session provides methods for searching among
OfferingConstrainerEnabler
objects. The search query is
constructed using the OfferingConstrainerEnableryQuery.
getOfferingConstrainerEnablersByQuery()
is the basic
search method and returns a list of OfferingConstrainerEnablers.
A more advanced search may be performed with
getOfferingConstrainerEnablersBySearch().
It accepts an
OfferingConstrainerEnablerSearch
in addition to the query for the
purpose of specifying additional options affecting the entire search, such
as offering. getOfferingConstrainerEnablersBySearch()
returns an OfferingConstrainerEnablerSearchResults
that can
be used to access the resulting OfferingConstrainerEnablerList
or be used to perform a search within the result set through
OfferingConstrainerEnablerSearch.
This session defines views that offer differing behaviors for searching.
OfferingConstrainerEnablers
may have a query record
indicated by their respective record types. The query record is accessed
via the OfferingConstrainerEnablerQuery.
Modifier and Type | Method and Description |
---|---|
OfferingConstrainerEnablerQuery |
getOfferingConstrainerEnablerQueryFromInspector(OfferingConstrainerEnablerQueryInspector offeringConstrainerEnablerQueryInspector)
Gets an offering constrainer enabler query from an inspector.
|
OfferingConstrainerEnablerSearchResults |
getOfferingConstrainerEnablersBySearch(OfferingConstrainerEnablerQuery offeringConstrainerEnablerQuery,
OfferingConstrainerEnablerSearch offeringConstrainerEnablerSearch)
Gets the search results matching the given search query using the
given search.
|
OfferingConstrainerEnablerSearch |
getOfferingConstrainerEnablerSearch()
Gets an offering constrainer enabler search.
|
OfferingConstrainerEnablerSearchOrder |
getOfferingConstrainerEnablerSearchOrder()
Gets an offering constrainer enabler search order.
|
canSearchOfferingConstrainerEnablers, getCatalogue, getCatalogueId, getOfferingConstrainerEnablerQuery, getOfferingConstrainerEnablersByQuery, useFederatedCatalogueView, useIsolatedCatalogueView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
OfferingConstrainerEnablerSearch getOfferingConstrainerEnablerSearch()
mandatory
- This method must be implemented. OfferingConstrainerEnablerSearchOrder getOfferingConstrainerEnablerSearchOrder()
OfferingConstrainerEnablerSearchOrder
is supplied to an
OfferingConstrainerEnablerSearch
to specify the ordering of
results.mandatory
- This method must be implemented. OfferingConstrainerEnablerSearchResults getOfferingConstrainerEnablersBySearch(OfferingConstrainerEnablerQuery offeringConstrainerEnablerQuery, OfferingConstrainerEnablerSearch offeringConstrainerEnablerSearch) throws OperationFailedException, PermissionDeniedException
offeringConstrainerEnablerQuery
- the offering constrainer
enabler queryofferingConstrainerEnablerSearch
- the offering constrainer
enabler searchNullArgumentException
-
offeringConstrainerEnablerQuery
or
offeringConstrainerEnablerSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
-
offeringConstrainerEnablerQuery
or
offeringConstrainerEnablerSearch
is not of this
servicemandatory
- This method must be implemented. OfferingConstrainerEnablerQuery getOfferingConstrainerEnablerQueryFromInspector(OfferingConstrainerEnablerQueryInspector offeringConstrainerEnablerQueryInspector)
OfferingConstrainerEnablerSearchResults.
offeringConstrainerEnablerQueryInspector
- an offering
constrainer enabler query inspectorNullArgumentException
-
offeringConstrainerEnablerQueryInspector
is
null
UnsupportedException
-
offeringConstrainerEnablerQueryInspector
is not of
this servicemandatory
- This method must be implemented.