public interface NodeSearchSession extends NodeQuerySession
This session provides methods for searching among Node
objects. The search query is constructed using the NodeQuery.
getNodesByQuery()
is the basic search method and
returns a list of Nodes.
A more advanced search may be
performed with getNodesBySearch().
It accepts a
NodeSearch
in addition to the query for the purpose of specifying
additional options affecting the entire search, such as ordering.
getNodesBySearch()
returns a NodeSearchResults
that
can be used to access the resulting NodeList
or be used to
perform a search within the result set through NodeSearch.
This session defines views that offer differing behaviors for searching.
Nodes may have a query record indicated by their respective record
types. The query record is accessed via the NodeQuery.
Modifier and Type | Method and Description |
---|---|
NodeQuery |
getNodeQueryFromInspector(NodeQueryInspector nodeQueryInspector)
Gets a node query from an inspector.
|
NodeSearchResults |
getNodesBySearch(NodeQuery nodeQuery,
NodeSearch nodeSearch)
Gets the search results matching the given search query using the
given search.
|
NodeSearch |
getNodeSearch()
Gets a node search.
|
NodeSearchOrder |
getNodeSearchOrder()
Gets a node search order.
|
canSearchNodes, getGraph, getGraphId, getNodeQuery, getNodesByQuery, useFederatedGraphView, useIsolatedGraphView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
NodeSearch getNodeSearch()
mandatory
- This method must be implemented. NodeSearchOrder getNodeSearchOrder()
NodeSearchOrder
is
supplied to a NodeSearch
to specify the ordering of
results.mandatory
- This method must be implemented. NodeSearchResults getNodesBySearch(NodeQuery nodeQuery, NodeSearch nodeSearch) throws OperationFailedException, PermissionDeniedException
nodeQuery
- the node querynodeSearch
- the node searchNullArgumentException
- nodeQuery
or
nodeSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- nodeQuery
or
nodeSearch
is not of this servicemandatory
- This method must be implemented. NodeQuery getNodeQueryFromInspector(NodeQueryInspector nodeQueryInspector)
NodeSearchResults.
nodeQueryInspector
- a node query inspectorNullArgumentException
- nodeQueryInspector
is null
UnsupportedException
- nodeQueryInspector
is not of this servicemandatory
- This method must be implemented.