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

Interface	osid.provisioning.rules.BrokerConstrainerSearchSession
Implements	`osid.provisioning.rules.BrokerConstrainerQuerySession`
Used By	`osid.provisioning.rules.ProvisioningRulesManager`
Used By	`osid.provisioning.rules.ProvisioningRulesProxyManager`
Description	This session provides methods for searching among `BrokerConstrainers` . The search query is constructed using the `BrokerConstrainerQuery` . `getBrokerConstrainersByQuery()` is the basic search method and returns a list of `BrokerConstrainers` . A more advanced search may be performed with `getBrokerConstrainersBySearch()` . It accepts a `BrokerConstrainerSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getBrokerConstrainersBySearch()` returns a `BrokerConstrainerSearchResults` that can be used to access the resulting `BrokerConstrainerList` or be used to perform a search within the result set through Br `okerConstrainerSearch` . This session defines views that offer differing behaviors for searching. federated distributor view: searches include broker constrainers in distributors of which this distributor is an ancestor in the distributor hierarchy isolated distributor view: searches are restricted to broker constrainers in this distributor Broker constrainers may have a query record indicated by their respective record types. The query record is accessed via the `BrokerConstrainerQuery` .
Method	getBrokerConstrainerSearch
Description	Gets a broker constrainer search.
Return	`osid.provisioning.rules.BrokerConstrainerSearch`		the broker constrainer search
Compliance	`mandatory`		This method must be implemented.
Method	getBrokerConstrainerSearchOrder
Description	Gets a broker constrainer search order. The `BrokerConstrainerSearchOrder` is supplied to a `BrokerConstrainerSearch` to specify the ordering of results.
Return	`osid.provisioning.rules.BrokerConstrainerSearchOrder`		the broker constrainer search order
Compliance	`mandatory`		This method must be implemented.
Method	getBrokerConstrainersBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.provisioning.rules.BrokerConstrainerQuery`	`brokerConstrainerQuery`	the broker constrainer query
Parameters	`osid.provisioning.rules.BrokerConstrainerSearch`	`brokerConstrainerSearch`	the broker constrainer search
Return	`osid.provisioning.rules.BrokerConstrainerSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`brokerConstrainerQuery` or `brokerConstrainerSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`brokerConstrainerQuery` or `brokerConstrainerSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getBrokerConstrainerQueryFromInspector
Description	Gets a broker constrainer query from an inspector. The inspector is available from a `BrokerConstrainerSearchResults` .
Parameters	`osid.provisioning.rules.BrokerConstrainerQueryInspector`	`brokerConstrainerQueryInspector`	a broker constrainer query inspector
Return	`osid.provisioning.rules.BrokerConstrainerQuery`		the broker constrainer query
Errors	NULL_ARGUMENT		`brokerConstrainerQueryInspector` is `null`
Errors	UNSUPPORTED		`brokerConstrainerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.