OSID - osid.topology.rules.EdgeEnablerSearchSession Service Interface Definition

Interface	osid.topology.rules.EdgeEnablerSearchSession
Implements	`osid.topology.rules.EdgeEnablerQuerySession`
Used By	`osid.topology.rules.TopologyRulesManager`
Used By	`osid.topology.rules.TopologyRulesProxyManager`
Description	This session provides methods for searching among `EdgeEnabler` objects. The search query is constructed using the `EdgeEnableryQuery` . `getEdgeEnablersByQuery()` is the basic search method and returns a list of `EdgeEnablers` . A more advanced search may be performed with `getEdgeEnablersBySearch()` .It accepts an `EdgeEnablerSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getEdgeEnablersBySearch()` returns an `EdgeEnablerSearchResults` that can be used to access the resulting `EdgeEnablerList` or be used to perform a search within the result set through `EdgeEnablerSearch` . This session defines views that offer differing behaviors for searching. federated graph view: searches include edge enablers in ontologies of which this graph is an ancestor in the graph hierarchy isolated graph view: searches are restricted to edge enablers in this graph `EdgeEnablers` may have a query record indicated by their respective record types. The query record is accessed via the `EdgeEnablerQuery` .
Method	getEdgeEnablerSearch
Description	Gets an edge enabler search.
Return	`osid.topology.rules.EdgeEnablerSearch`		the edge enabler search
Compliance	`mandatory`		This method must be implemented.
Method	getEdgeEnablerSearchOrder
Description	Gets an edge enabler search order. The `EdgeEnablerSearchOrder` is supplied to an `EdgeEnablerSearch` to specify the ordering of results.
Return	`osid.topology.rules.EdgeEnablerSearchOrder`		the edge enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	getEdgeEnablersBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.topology.rules.EdgeEnablerQuery`	`edgeEnablerQuery`	the edge enabler query
Parameters	`osid.topology.rules.EdgeEnablerSearch`	`edgeEnablerSearch`	the edge enabler search
Return	`osid.topology.rules.EdgeEnablerSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`edgeEnablerQuery` or `edgeEnablerSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`edgeEnablerQuery` or `edgeEnablerSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getEdgeEnablerQueryFromInspector
Description	Gets an edge enabler query from an inspector. The inspector is available from an `EdgeEnablerSearchResults` .
Parameters	`osid.topology.rules.EdgeEnablerQueryInspector`	`edgeEnablerQueryInspector`	an edge enabler query inspector
Return	`osid.topology.rules.EdgeEnablerQuery`		the edge enabler query
Errors	NULL_ARGUMENT		`edgeEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`edgeEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.