OSID - osid.provisioning.rules.ProvisionableEnablerSearchSession Service Interface Definition

Interface	osid.provisioning.rules.ProvisionableEnablerSearchSession
Implements	`osid.provisioning.rules.ProvisionableEnablerQuerySession`
Used By	`osid.provisioning.rules.ProvisioningRulesManager`
Used By	`osid.provisioning.rules.ProvisioningRulesProxyManager`
Description	This session provides methods for searching among `ProvisionableEnablers` . The search query is constructed using the `ProvisionableEnablerQuery` . `getProvisionableEnablersByQuery()` is the basic search method and returns a list of `ProvisionableEnablers` . A more advanced search may be performed with `getProvisionableEnablersBySearch()` . It accepts a `ProvisionableEnablerSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getProvisionableEnablersBySearch()` returns a `ProvisionableEnablerSearchResults` that can be used to access the resulting `ProvisionableEnablerList` or be used to perform a search within the result set through `ProvisionableEnablerSearch` . This session defines views that offer differing behaviors for searching. federated distributor view: searches include provisionable enablers in distributors of which this distributor is an ancestor in the distributor hierarchy isolated distributor view: searches are restricted to provisionable enablers in this distributor Provisionable enablers may have a query record indicated by their respective record types. The query record is accessed via the `ProvisionableEnablerQuery` .
Method	getProvisionableEnablerSearch
Description	Gets a provisionable enabler search.
Return	`osid.provisioning.rules.ProvisionableEnablerSearch`		the provisionable enabler search
Compliance	`mandatory`		This method must be implemented.
Method	getProvisionableEnablerSearchOrder
Description	Gets a provisionable enabler search order. The `ProvisionableEnablerSearchOrder` is supplied to a `ProvisionableEnablerSearch` to specify the ordering of results.
Return	`osid.provisioning.rules.ProvisionableEnablerSearchOrder`		the provisionable enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	getProvisionableEnablersBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.provisioning.rules.ProvisionableEnablerQuery`	`provisionableEnablerQuery`	the provisionable enabler query
Parameters	`osid.provisioning.rules.ProvisionableEnablerSearch`	`provisionableEnablerSearch`	the provisionable enabler search
Return	`osid.provisioning.rules.ProvisionableEnablerSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`provisionableEnablerQuery` or `provisionableEnablerSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`provisionableEnablerQuery` or `provisionableEnablerSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getProvisionableEnablerQueryFromInspector
Description	Gets a provisionable enabler query from an inspector. The inspector is available from a `ProvisionableEnablerSearchResults` .
Parameters	`osid.provisioning.rules.ProvisionableEnablerQueryInspector`	`provisionableEnablerQueryInspector`	a provisionable enabler query inspector
Return	`osid.provisioning.rules.ProvisionableEnablerQuery`		the provisionable enabler query
Errors	NULL_ARGUMENT		`provisionableEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`provisionableEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.