OSID - osid.topology.EdgeSearchSession Service Interface Definition

Interface	osid.topology.EdgeSearchSession
Implements	`osid.topology.EdgeQuerySession`
Used By	`osid.topology.TopologyManager`
Used By	`osid.topology.TopologyProxyManager`
Description	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. federated graph view: searches include edges in graphs of which this graph is an ancestor in the graph hierarchy isolated graph view: searches are restricted to edges in this graph Edges may have a query record indicated by their respective record types. The query record is accessed via the `EdgeQuery` .
Method	getEdgeSearch
Description	Gets an edge search.
Return	`osid.topology.EdgeSearch`		the edge search
Compliance	`mandatory`		This method must be implemented.
Method	getEdgeSearchOrder
Description	Gets an edge search order. The `EdgeSearchOrder` is supplied to an `EdgeSearch` to specify the ordering of results.
Return	`osid.topology.EdgeSearchOrder`		the edge search order
Compliance	`mandatory`		This method must be implemented.
Method	getEdgesBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.topology.EdgeQuery`	`edgeQuery`	the edge query
Parameters	`osid.topology.EdgeSearch`	`edgeSearch`	the edge search
Return	`osid.topology.EdgeSearchResults`		the edge search results
Errors	NULL_ARGUMENT		`edgeQuery` or `edgeSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`edgeQuery` or `edgeSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getEdgeQueryFromInspector
Description	Gets an edge query from an inspector. The inspector is available from an `EdgeSearchResults` .
Parameters	`osid.topology.EdgeQueryInspector`	`edgeQueryInspector`	an edge query inspector
Return	`osid.topology.EdgeQuery`		the edge query
Errors	NULL_ARGUMENT		`edgeQueryInspector` is `null`
Errors	UNSUPPORTED		`edgeQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.