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

Interface	osid.control.rules.TriggerEnablerSearchSession
Implements	`osid.control.rules.TriggerEnablerQuerySession`
Used By	`osid.control.rules.ControlRulesManager`
Used By	`osid.control.rules.ControlRulesProxyManager`
Description	This session provides methods for searching among `TriggerEnabler` objects. The search query is constructed using the `TriggerEnableryQuery`. `getTriggerEnablersByQuery()` is the basic search method and returns a list of `TriggerEnablers`. A more advanced search may be performed with `getTriggerEnablersBySearch()`. It accepts a `TriggerEnablerSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as offering. `getTriggerEnablersBySearch()` returns a `TriggerEnablerSearchResults` that can be used to access the resulting `TriggerEnablerList` or be used to perform a search within the result set through `TriggerEnablerSearch`. This session defines views that offer differing behaviors for searching. federated system view: searches include trigger enablers in systems of which this system is an ancestor in the system hierarchy isolated system view: searches are restricted to trigger enablers in this system `TriggerEnablers` may have a query record indicated by their respective record types. The query record is accessed via the `TriggerEnablerQuery`.
Method	getTriggerEnablerSearch
Description	Gets a trigger enabler search.
Return	`osid.control.rules.TriggerEnablerSearch`		the trigger enabler search
Compliance	`mandatory`		This method must be implemented.
Method	getTriggerEnablerSearchOrder
Description	Gets a trigger enabler search order. The `TriggerEnablerSearchOrder` is supplied to a `TriggerEnablerSearch` to specify the ordering of results.
Return	`osid.control.rules.TriggerEnablerSearchOrder`		the trigger enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	getTriggerEnablersBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.control.rules.TriggerEnablerQuery`	`triggerEnablerQuery`	the trigger enabler query
Parameters	`osid.control.rules.TriggerEnablerSearch`	`triggerEnablerSearch`	the trigger enabler search
Return	`osid.control.rules.TriggerEnablerSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`triggerEnablerQuery` or `triggerEnablerSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`triggerEnablerQuery` or `triggerEnablerSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getTriggerEnablerQueryFromInspector
Description	Gets a trigger enabler query from an inspector. The inspector is available from a `TriggerEnablerSearchResults`.
Parameters	`osid.control.rules.TriggerEnablerQueryInspector`	`triggerEnablerQueryInspector`	a trigger enabler query inspector
Return	`osid.control.rules.TriggerEnablerQuery`		the trigger enabler query
Errors	NULL_ARGUMENT		`triggerEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`triggerEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.