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

Interface	osid.provisioning.rules.BrokerProcessorEnablerSearchSession
Implements	`osid.provisioning.rules.BrokerProcessorEnablerQuerySession`
Used By	`osid.provisioning.rules.ProvisioningRulesManager`
Used By	`osid.provisioning.rules.ProvisioningRulesProxyManager`
Description	This session provides methods for searching among `BrokerProcessorEnablers` . The search query is constructed using the `BrokerProcessorEnablerQuery` . `getBrokerProcessorEnablersByQuery()` is the basic search method and returns a list of `BrokerProcessorEnablers` . A more advanced search may be performed with `getBrokerProcessorEnablersBySearch()` .It accepts a `BrokerProcessorEnablerSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getBrokerProcessorEnablersBySearch()` returns a `BrokerProcessorEnablerSearchResults` that can be used to access the resulting `BrokerProcessorEnablerList` or be used to perform a search within the result set through `BrokerProcessorEnablerSearch` . This session defines views that offer differing behaviors for searching. federated distributor view: searches include broker processor enablers in distributors of which this distributor is an ancestor in the distributor hierarchy isolated distributor view: searches are restricted to broker processor enablers in this distributor Broker processor enablers may have a query record indicated by their respective record types. The query record is accessed via the `BrokerProcessorEnablerQuery` .
Method	getBrokerProcessorEnablerSearch
Description	Gets a broker processor enabler search.
Return	`osid.provisioning.rules.BrokerProcessorEnablerSearch`		the broker processor enabler search
Compliance	`mandatory`		This method must be implemented.
Method	getBrokerProcessorEnablerSearchOrder
Description	Gets a broker processor enabler search order. The `BrokerProcessorEnablerSearchOrder` is supplied to a `BrokerProcessorEnablerSearch` to specify the ordering of results.
Return	`osid.provisioning.rules.BrokerProcessorEnablerSearchOrder`		the broker processor enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	getBrokerProcessorEnablersBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.provisioning.rules.BrokerProcessorEnablerQuery`	`brokerProcessorEnablerQuery`	the broker processor enabler query
Parameters	`osid.provisioning.rules.BrokerProcessorEnablerSearch`	`brokerProcessorEnablerSearch`	the broker processor enabler search
Return	`osid.provisioning.rules.BrokerProcessorEnablerSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`brokerProcessorEnablerQuery` or `brokerProcessorEnablerSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`brokerProcessorEnablerQuery` or `brokerProcessorEnablerSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getBrokerProcessorEnablerQueryFromInspector
Description	Gets a broker processor enabler query from an inspector. The inspector is available from a `BrokerProcessorEnablerSearchResults` .
Parameters	`osid.provisioning.rules.BrokerProcessorEnablerQueryInspector`	`brokerProcessorEnablerQueryInspector`	a broker processor enabler query inspector
Return	`osid.provisioning.rules.BrokerProcessorEnablerQuery`		the broker processor enabler query
Errors	NULL_ARGUMENT		`brokerProcessorEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`brokerProcessorEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.