OSID - osid.topology.GraphSearchSession Service Interface Definition

Interface	osid.topology.GraphSearchSession
Implements	`osid.topology.GraphQuerySession`
Used By	`osid.topology.TopologyManager`
Used By	`osid.topology.TopologyProxyManager`
Description	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`.
Method	getGraphSearch
Description	Gets a graph search.
Return	`osid.topology.GraphSearch`		the graph search
Compliance	`mandatory`		This method must be implemented.
Method	getGraphSearchOrder
Description	Gets a graph search order. The `GraphSearchOrder` is supplied to a `GraphSearch` to specify the ordering of results.
Return	`osid.topology.GraphSearchOrder`		the graph search order
Compliance	`mandatory`		This method must be implemented.
Method	getGraphsBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.topology.GraphQuery`	`graphQuery`	the graph query
Parameters	`osid.topology.GraphSearch`	`graphSearch`	the graph search
Return	`osid.topology.GraphSearchResults`		the graph search results
Errors	NULL_ARGUMENT		`graphQuery` or `graphSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`graphQuery` or `graphSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getGraphQueryFromInspector
Description	Gets a graph query from an inspector. The inspector is available from a `GraphSearchResults`.
Parameters	`osid.topology.GraphQueryInspector`	`graphQueryInspector`	a graph query inspector
Return	`osid.topology.GraphQuery`		the graph query
Errors	NULL_ARGUMENT		`graphQueryInspector` is `null`
Errors	UNSUPPORTED		`graphQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.