OSID - osid.provisioning.BrokerSearchSession Service Interface Definition

Interface	osid.provisioning.BrokerSearchSession
Implements	`osid.provisioning.BrokerQuerySession`
Used By	`osid.provisioning.ProvisioningManager`
Used By	`osid.provisioning.ProvisioningProxyManager`
Description	This session provides methods for searching among `Broker` objects. The search query is constructed using the `BrokerQuery`. `getBrokersByQuery()` is the basic search method and returns a list of `Brokers`. A more advanced search may be performed with `getBrokersBySearch()` .It accepts a `BrokerSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getBrokersBySearch()` returns a `BrokerSearchResults` that can be used to access the resulting `BrokerList` or be used to perform a search within the result set through `BrokerSearch` . This session defines views that offer differing behaviors for searching. federated distributor view: searches include brokers in distributors of which this distributor is an ancestor in the distributor hierarchy isolated distributor view: searches are restricted to brokers in this distributor Brokers may have a query record indicated by their respective record types. The query record is accessed via the `BrokerQuery`.
Method	getBrokerSearch
Description	Gets a broker search.
Return	`osid.provisioning.BrokerSearch`		the broker search
Compliance	`mandatory`		This method must be implemented.
Method	getBrokerSearchOrder
Description	Gets a broker search order. The `BrokerSearchOrder` is supplied to a `BrokerSearch` to specify the ordering of results.
Return	`osid.provisioning.BrokerSearchOrder`		the broker search order
Compliance	`mandatory`		This method must be implemented.
Method	getBrokersBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.provisioning.BrokerQuery`	`brokerQuery`	the broker query
Parameters	`osid.provisioning.BrokerSearch`	`brokerSearch`	the broker search
Return	`osid.provisioning.BrokerSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`brokerQuery` or `brokerSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`brokerQuery` or `brokerSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getBrokerQueryFromInspector
Description	Gets a broker query from an inspector. The inspector is available from a `BrokerSearchResults`.
Parameters	`osid.provisioning.BrokerQueryInspector`	`brokerQueryInspector`	a broker query inspector
Return	`osid.provisioning.BrokerQuery`		the broker query
Errors	NULL_ARGUMENT		`brokerQueryInspector` is `null`
Errors	UNSUPPORTED		`brokerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.