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

Interface	osid.provisioning.rules.BrokerProcessorSearchSession
Implements	`osid.provisioning.rules.BrokerProcessorQuerySession`
Used By	`osid.provisioning.rules.ProvisioningRulesManager`
Used By	`osid.provisioning.rules.ProvisioningRulesProxyManager`
Description	This session provides methods for searching among `BrokerProcessors` . The search query is constructed using the `BrokerProcessorQuery` . `getBrokerProcessorsByQuery()` is the basic search method and returns a list of `BrokerProcessors` . A more advanced search may be performed with `getBrokerProcessorsBySearch()` . It accepts a `BrokerProcessorSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getBrokerProcessorsBySearch()` returns a `BrokerProcessorSearchResults` that can be used to access the resulting `BrokerProcessorList` or be used to perform a search within the result set through Br `okerProcessorSearch` . This session defines views that offer differing behaviors for searching. federated distributor view: searches include broker processors in distributors of which this distributor is an ancestor in the distributor hierarchy isolated distributor view: searches are restricted to broker processors in this distributor Broker processors may have a query record indicated by their respective record types. The query record is accessed via the `BrokerProcessorQuery` .
Method	getBrokerProcessorSearch
Description	Gets a broker processor search.
Return	`osid.provisioning.rules.BrokerProcessorSearch`		the broker processor search
Compliance	`mandatory`		This method must be implemented.
Method	getBrokerProcessorSearchOrder
Description	Gets a broker processor search order. The `BrokerProcessorSearchOrder` is supplied to a `BrokerProcessorSearch` to specify the ordering of results.
Return	`osid.provisioning.rules.BrokerProcessorSearchOrder`		the broker processor search order
Compliance	`mandatory`		This method must be implemented.
Method	getBrokerProcessorsBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.provisioning.rules.BrokerProcessorQuery`	`brokerProcessorQuery`	the broker processor query
Parameters	`osid.provisioning.rules.BrokerProcessorSearch`	`brokerProcessorSearch`	the broker processor search
Return	`osid.provisioning.rules.BrokerProcessorSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`brokerProcessorQuery` or `brokerProcessorSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`brokerProcessorQuery` or `brokerProcessorSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getBrokerProcessorQueryFromInspector
Description	Gets a broker processor query from an inspector. The inspector is available from a `BrokerProcessorSearchResults` .
Parameters	`osid.provisioning.rules.BrokerProcessorQueryInspector`	`brokerProcessorQueryInspector`	a broker processor query inspector
Return	`osid.provisioning.rules.BrokerProcessorQuery`		the broker processor query
Errors	NULL_ARGUMENT		`brokerProcessorQueryInspector` is `null`
Errors	UNSUPPORTED		`brokerProcessorQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.