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

Interface	osid.provisioning.rules.BrokerEnablerSearchSession
Implements	`osid.provisioning.rules.BrokerEnablerQuerySession`
Used By	`osid.provisioning.rules.ProvisioningRulesManager`
Used By	`osid.provisioning.rules.ProvisioningRulesProxyManager`
Description	This session provides methods for searching among `BrokerEnablers` . The search query is constructed using the `BrokerEnablerQuery` . `getBrokerEnablersByQuery()` is the basic search method and returns a list of `BrokerEnablers` . A more advanced search may be performed with `getBrokerEnablersBySearch()` .It accepts a `BrokerEnablerSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getBrokerEnablersBySearch()` returns a `BrokerEnablerSearchResults` that can be used to access the resulting `BrokerEnablerList` or be used to perform a search within the result set through Br `okerEnablerSearch` . This session defines views that offer differing behaviors for searching. federated distributor view: searches include broker enablers in distributors of which this distributor is an ancestor in the distributor hierarchy isolated distributor view: searches are restricted to broker enablers in this distributor Broker enablers may have a query record indicated by their respective record types. The query record is accessed via the `BrokerEnablerQuery` .
Method	getBrokerEnablerSearch
Description	Gets a broker enabler search.
Return	`osid.provisioning.rules.BrokerEnablerSearch`		the broker enabler search
Compliance	`mandatory`		This method must be implemented.
Method	getBrokerEnablerSearchOrder
Description	Gets a broker enabler search order. The `BrokerEnablerSearchOrder` is supplied to a `BrokerEnablerSearch` to specify the ordering of results.
Return	`osid.provisioning.rules.BrokerEnablerSearchOrder`		the broker enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	getBrokerEnablersBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.provisioning.rules.BrokerEnablerQuery`	`brokerEnablerQuery`	the broker enabler query
Parameters	`osid.provisioning.rules.BrokerEnablerSearch`	`brokerEnablerSearch`	the broker enabler search
Return	`osid.provisioning.rules.BrokerEnablerSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`brokerEnablerQuery` or `brokerEnablerSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`brokerEnablerQuery` or `brokerEnablerSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getBrokerEnablerQueryFromInspector
Description	Gets a broker enabler query from an inspector. The inspector is available from a `BrokerEnablerSearchResults` .
Parameters	`osid.provisioning.rules.BrokerEnablerQueryInspector`	`brokerEnablerQueryInspector`	a broker enabler query inspector
Return	`osid.provisioning.rules.BrokerEnablerQuery`		the broker enabler query
Errors	NULL_ARGUMENT		`brokerEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`brokerEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.