public interface GraphSearchSession extends GraphQuerySession
This session provides methods for searching among Graph
objects. The search query is constructed using the GraphQuery.
getGraphsByQuery()
is the basic search method and
returns a list of Graphs.
A more advanced search may be
performed with getGraphsBySearch().
It accepts a
GraphSearch
in addition to the query for the purpose of specifying
additional options affecting the entire search, such as ordering.
getGraphsBySearch()
returns a GraphSearchResults
that can be used to access the resulting GraphList
or be
used to perform a search within the result set through GraphSearch.
Graphs may have a query record indicated by their respective record
types. The query record is accessed via the GraphQuery.
Modifier and Type | Method and Description |
---|---|
GraphQuery |
getGraphQueryFromInspector(GraphQueryInspector graphQueryInspector)
Gets a graph query from an inspector.
|
GraphSearchResults |
getGraphsBySearch(GraphQuery graphQuery,
GraphSearch graphSearch)
Gets the search results matching the given search query using the
given search.
|
GraphSearch |
getGraphSearch()
Gets a graph search.
|
GraphSearchOrder |
getGraphSearchOrder()
Gets a graph search order.
|
canSearchGraphs, getGraphQuery, getGraphsByQuery
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
GraphSearch getGraphSearch()
mandatory
- This method must be implemented. GraphSearchOrder getGraphSearchOrder()
GraphSearchOrder
is
supplied to a GraphSearch
to specify the ordering of
results.mandatory
- This method must be implemented. GraphSearchResults getGraphsBySearch(GraphQuery graphQuery, GraphSearch graphSearch) throws OperationFailedException, PermissionDeniedException
graphQuery
- the graph querygraphSearch
- the graph searchNullArgumentException
- graphQuery
or
graphSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- graphQuery
or
graphSearch
is not of this servicemandatory
- This method must be implemented. GraphQuery getGraphQueryFromInspector(GraphQueryInspector graphQueryInspector)
GraphSearchResults.
graphQueryInspector
- a graph query inspectorNullArgumentException
- graphQueryInspector
is null
UnsupportedException
- graphQueryInspector
is not of this servicemandatory
- This method must be implemented.