OSID - osid.control.rules.ActionEnablerSearchSession Service Interface Definition

Interface	osid.control.rules.ActionEnablerSearchSession
Implements	`osid.control.rules.ActionEnablerQuerySession`
Description	This session provides methods for searching among `ActionEnabler` objects. The search query is constructed using the `ActionEnableryQuery.` `getActionEnablersByQuery()` is the basic search method and returns a list of `ActionEnablers.` An more advanced search may be performed with `getActionEnablersBySearch().` It accepts an `ActionEnablerSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as control. `getActionEnablersBySearch()` returns an `ActionEnablerSearchResults` that can be used to access the resulting `ActionEnablerList` or be used to perform a search within the result set through `ActionEnablerSearch.` This session defines views that offer differing behaviors for searching. federated system view: searches include action enablers in systems of which this system is an ancestor in the system hierarchy isolated system view: searches are restricted to action enablers in this system `ActionEnablers` may have a query record indicated by their respective record types. The query record is accessed via the `ActionEnablerQuery.`
Method	getActionEnablerSearch
Description	Gets an action enabler search.
Return	`osid.control.rules.ActionEnablerSearch`		the action enabler search
Compliance	`mandatory`		This method must be implemented.
Method	getActionEnablerSearchOrder
Description	Gets an action enabler search order. The `ActionEnablerSearchOrder` is supplied to an `ActionEnablerSearch` to specify the ordering of results.
Return	`osid.control.rules.ActionEnablerSearchOrder`		the action enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	getActionEnablersBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.control.rules.ActionEnablerQuery`	`actionEnablerQuery`	the action enabler query
Parameters	`osid.control.rules.ActionEnablerSearch`	`actionEnablerSearch`	the action enabler search
Return	`osid.control.rules.ActionEnablerSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`actionEnablerQuery` or `actionEnablerSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`actionEnablerQuery` or `actionEnablerSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getActionEnablerQueryFromInspector
Description	Gets an action enabler query from an inspector. The inspector is available from an `ActionEnablerSearchResults.`
Parameters	`osid.control.rules.ActionEnablerQueryInspector`	`actionEnablerQueryInspector`	an action enabler query inspector
Return	`osid.control.rules.ActionEnablerQuery`		the action enabler query
Errors	NULL_ARGUMENT		`actionEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`actionEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.