public interface EdgeSearchSession extends EdgeQuerySession
This session provides methods for searching among Edge
objects. The search query is constructed using the EdgeQuery.
getEdgesByQuery()
is the basic search method and
returns a list of Edges.
A more advanced search may be
performed with getEdgesBySearch().
It accepts an
EdgeSearch
in addition to the query for the purpose of specifying
additional options affecting the entire search, such as ordering.
getEdgesBySearch()
returns an EdgesSearchResults
that can be used to access the resulting EdgeList
or be
used to perform a search within the result set through EdgeSearch.
This session defines views that offer differing behaviors for searching.
Edges may have a query record indicated by their respective record
types. The query record is accessed via the EdgeQuery.
Modifier and Type | Method and Description |
---|---|
EdgeQuery |
getEdgeQueryFromInspector(EdgeQueryInspector edgeQueryInspector)
Gets an edge query from an inspector.
|
EdgeSearchResults |
getEdgesBySearch(EdgeQuery edgeQuery,
EdgeSearch edgeSearch)
Gets the search results matching the given search query using the
given search.
|
EdgeSearch |
getEdgeSearch()
Gets an edge search.
|
EdgeSearchOrder |
getEdgeSearchOrder()
Gets an edge search order.
|
canSearchEdges, getEdgeQuery, getEdgesByQuery, getGraph, getGraphId, useFederatedGraphView, useIsolatedGraphView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
EdgeSearch getEdgeSearch()
mandatory
- This method must be implemented. EdgeSearchOrder getEdgeSearchOrder()
EdgeSearchOrder
is
supplied to an EdgeSearch
to specify the ordering of
results.mandatory
- This method must be implemented. EdgeSearchResults getEdgesBySearch(EdgeQuery edgeQuery, EdgeSearch edgeSearch) throws OperationFailedException, PermissionDeniedException
edgeQuery
- the edge queryedgeSearch
- the edge searchNullArgumentException
- edgeQuery
or
edgeSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- edgeQuery
or
edgeSearch
is not of this servicemandatory
- This method must be implemented. EdgeQuery getEdgeQueryFromInspector(EdgeQueryInspector edgeQueryInspector)
EdgeSearchResults.
edgeQueryInspector
- an edge query inspectorNullArgumentException
- edgeQueryInspector
is null
UnsupportedException
- edgeQueryInspector
is not of this servicemandatory
- This method must be implemented.