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

Interface	osid.provisioning.rules.ProvisionEnablerSearchSession
Implements	`osid.provisioning.rules.ProvisionEnablerQuerySession`
Used By	`osid.provisioning.rules.ProvisioningRulesManager`
Used By	`osid.provisioning.rules.ProvisioningRulesProxyManager`
Description	This session provides methods for searching among `ProvisionEnablers` . The search query is constructed using the `ProvisionEnablerQuery` . `getProvisionEnablersByQuery()` is the basic search method and returns a list of `ProvisionEnablers` . A more advanced search may be performed with `getProvisionEnablersBySearch()` . It accepts a `ProvisionEnablerSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getProvisionEnablersBySearch()` returns a `ProvisionEnablerSearchResults` that can be used to access the resulting `ProvisionEnablerList` or be used to perform a search within the result set through `ProvisionEnablerSearch` . This session defines views that offer differing behaviors for searching. federated distributor view: searches include provision enablers in distributors of which this distributor is an ancestor in the distributor hierarchy isolated distributor view: searches are restricted to provision enablers in this distributor Provision enablers may have a query record indicated by their respective record types. The query record is accessed via the `ProvisionEnablerQuery` .
Method	getProvisionEnablerSearch
Description	Gets a provision enabler search.
Return	`osid.provisioning.rules.ProvisionEnablerSearch`		the provision enabler search
Compliance	`mandatory`		This method must be implemented.
Method	getProvisionEnablerSearchOrder
Description	Gets a provision enabler search order. The `ProvisionEnablerSearchOrder` is supplied to a `ProvisionEnablerSearch` to specify the ordering of results.
Return	`osid.provisioning.rules.ProvisionEnablerSearchOrder`		the provision enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	getProvisionEnablersBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.provisioning.rules.ProvisionEnablerQuery`	`provisionEnablerQuery`	the provision enabler query
Parameters	`osid.provisioning.rules.ProvisionEnablerSearch`	`provisionEnablerSearch`	the provision enabler search
Return	`osid.provisioning.rules.ProvisionEnablerSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`provisionEnablerQuery` or `provisionEnablerSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`provisionEnablerQuery` or `provisionEnablerSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getProvisionEnablerQueryFromInspector
Description	Gets a provision enabler query from an inspector. The inspector is available from a `ProvisionEnablerSearchResults` .
Parameters	`osid.provisioning.rules.ProvisionEnablerQueryInspector`	`provisionEnablerQueryInspector`	a provision enabler query inspector
Return	`osid.provisioning.rules.ProvisionEnablerQuery`		the provision enabler query
Errors	NULL_ARGUMENT		`provisionEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`provisionEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.