public interface EdgeEnablerSearchSession extends EdgeEnablerQuerySession
This session provides methods for searching among EdgeEnabler
objects. The search query is constructed using the
EdgeEnableryQuery.
getEdgeEnablersByQuery()
is the basic search method and
returns a list of EdgeEnablers.
A more advanced search may
be performed with getEdgeEnablersBySearch().
It accepts an
EdgeEnablerSearch
in addition to the query for the purpose
of specifying additional options affecting the entire search, such as
ordering. getEdgeEnablersBySearch()
returns an
EdgeEnablerSearchResults
that can be used to access the resulting
EdgeEnablerList
or be used to perform a search within the
result set through EdgeEnablerSearch.
This session defines views that offer differing behaviors for searching.
EdgeEnablers
may have a query record indicated by their
respective record types. The query record is accessed via the
EdgeEnablerQuery.
Modifier and Type | Method and Description |
---|---|
EdgeEnablerQuery |
getEdgeEnablerQueryFromInspector(EdgeEnablerQueryInspector edgeEnablerQueryInspector)
Gets an edge enabler query from an inspector.
|
EdgeEnablerSearchResults |
getEdgeEnablersBySearch(EdgeEnablerQuery edgeEnablerQuery,
EdgeEnablerSearch edgeEnablerSearch)
Gets the search results matching the given search query using the
given search.
|
EdgeEnablerSearch |
getEdgeEnablerSearch()
Gets an edge enabler search.
|
EdgeEnablerSearchOrder |
getEdgeEnablerSearchOrder()
Gets an edge enabler search order.
|
canSearchEdgeEnablers, getEdgeEnablerQuery, getEdgeEnablersByQuery, getGraph, getGraphId, useFederatedGraphView, useIsolatedGraphView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
EdgeEnablerSearch getEdgeEnablerSearch()
mandatory
- This method must be implemented. EdgeEnablerSearchOrder getEdgeEnablerSearchOrder()
EdgeEnablerSearchOrder
is supplied to an EdgeEnablerSearch
to specify
the ordering of results.mandatory
- This method must be implemented. EdgeEnablerSearchResults getEdgeEnablersBySearch(EdgeEnablerQuery edgeEnablerQuery, EdgeEnablerSearch edgeEnablerSearch) throws OperationFailedException, PermissionDeniedException
edgeEnablerQuery
- the edge enabler queryedgeEnablerSearch
- the edge enabler searchNullArgumentException
- edgeEnablerQuery
or edgeEnablerSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- edgeEnablerQuery
or edgeEnablerSearch
is not of this servicemandatory
- This method must be implemented. EdgeEnablerQuery getEdgeEnablerQueryFromInspector(EdgeEnablerQueryInspector edgeEnablerQueryInspector)
EdgeEnablerSearchResults.
edgeEnablerQueryInspector
- an edge enabler query inspectorNullArgumentException
-
edgeEnablerQueryInspector
is null
UnsupportedException
- edgeEnablerQueryInspector
is not of this servicemandatory
- This method must be implemented.