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

Interface	osid.control.rules.DeviceEnablerSearchSession
Implements	`osid.control.rules.DeviceEnablerQuerySession`
Used By	`osid.control.rules.ControlRulesManager`
Used By	`osid.control.rules.ControlRulesProxyManager`
Description	This session provides methods for searching among `DeviceEnabler` objects. The search query is constructed using the `DeviceEnableryQuery`. `getDeviceEnablersByQuery()` is the basic search method and returns a list of `DeviceEnablers`. A more advanced search may be performed with `getDeviceEnablersBySearch()`.It accepts a `DeviceEnablerSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as offering. `getDeviceEnablersBySearch()` returns a `DeviceEnablerSearchResults` that can be used to access the resulting `DeviceEnablerList` or be used to perform a search within the result set through `DeviceEnablerSearch`. This session defines views that offer differing behaviors for searching. federated system view: searches include device enablers in systems of which this system is an ancestor in the system hierarchy isolated system view: searches are restricted to device enablers in this system `DeviceEnablers` may have a query record indicated by their respective record types. The query record is accessed via the `DeviceEnablerQuery`.
Method	getDeviceEnablerSearch
Description	Gets a device enabler search.
Return	`osid.control.rules.DeviceEnablerSearch`		the device enabler search
Compliance	`mandatory`		This method must be implemented.
Method	getDeviceEnablerSearchOrder
Description	Gets a device enabler search order. The `DeviceEnablerSearchOrder` is supplied to a `DeviceEnablerSearch` to specify the ordering of results.
Return	`osid.control.rules.DeviceEnablerSearchOrder`		the device enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	getDeviceEnablersBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.control.rules.DeviceEnablerQuery`	`deviceEnablerQuery`	the device enabler query
Parameters	`osid.control.rules.DeviceEnablerSearch`	`deviceEnablerSearch`	the device enabler search
Return	`osid.control.rules.DeviceEnablerSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`deviceEnablerQuery` or `deviceEnablerSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`deviceEnablerQuery` or `deviceEnablerSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getDeviceEnablerQueryFromInspector
Description	Gets a device enabler query from an inspector. The inspector is available from a `DeviceEnablerSearchResults`.
Parameters	`osid.control.rules.DeviceEnablerQueryInspector`	`deviceEnablerQueryInspector`	a device enabler query inspector
Return	`osid.control.rules.DeviceEnablerQuery`		the device enabler query
Errors	NULL_ARGUMENT		`deviceEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`deviceEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.