OSID - osid.topology.NodeSearchSession Service Interface Definition

Interface	osid.topology.NodeSearchSession
Implements	`osid.topology.NodeQuerySession`
Used By	`osid.topology.TopologyManager`
Used By	`osid.topology.TopologyProxyManager`
Description	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. federated graph view: searches include nodes in graphs of which this graph is an ancestor in the graph hierarchy isolated graph view: searches are restricted to nodes in this graph Nodes may have a query record indicated by their respective record types. The query record is accessed via the `NodeQuery` .
Method	getNodeSearch
Description	Gets a node search.
Return	`osid.topology.NodeSearch`		the node search
Compliance	`mandatory`		This method must be implemented.
Method	getNodeSearchOrder
Description	Gets a node search order. The `NodeSearchOrder` is supplied to a `NodeSearch` to specify the ordering of results.
Return	`osid.topology.NodeSearchOrder`		the node search order
Compliance	`mandatory`		This method must be implemented.
Method	getNodesBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.topology.NodeQuery`	`nodeQuery`	the node query
Parameters	`osid.topology.NodeSearch`	`nodeSearch`	the node search
Return	`osid.topology.NodeSearchResults`		the node search results
Errors	NULL_ARGUMENT		`nodeQuery` or `nodeSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`nodeQuery` or `nodeSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getNodeQueryFromInspector
Description	Gets a node query from an inspector. The inspector is available from a `NodeSearchResults` .
Parameters	`osid.topology.NodeQueryInspector`	`nodeQueryInspector`	a node query inspector
Return	`osid.topology.NodeQuery`		the node query
Errors	NULL_ARGUMENT		`nodeQueryInspector` is `null`
Errors	UNSUPPORTED		`nodeQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.