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

Interface	osid.provisioning.rules.BrokerConstrainerEnablerSearchSession
Implements	`osid.provisioning.rules.BrokerConstrainerEnablerQuerySession`
Used By	`osid.provisioning.rules.ProvisioningRulesManager`
Used By	`osid.provisioning.rules.ProvisioningRulesProxyManager`
Description	This session provides methods for searching among `BrokerConstrainerEnablers` . The search query is constructed using the `BrokerConstrainerEnablerQuery` . `getBrokerConstrainerEnablersByQuery()` is the basic search method and returns a list of `BrokerConstrainerEnablers` . A more advanced search may be performed with `getBrokerConstrainerEnablersBySearch()` .It accepts a `BrokerConstrainerEnablerSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getBrokerConstrainerEnablersBySearch()` returns a `BrokerConstrainerEnablerSearchResults` that can be used to access the resulting `BrokerConstrainerEnablerList` or be used to perform a search within the result set through `BrokerConstrainerEnablerSearch` . This session defines views that offer differing behaviors for searching. federated distributor view: searches include broker constrainer enablers in distributors of which this distributor is an ancestor in the distributor hierarchy isolated distributor view: searches are restricted to broker constrainer enablers in this distributor Broker constrainer enablers may have a query record indicated by their respective record types. The query record is accessed via the `BrokerConstrainerEnablerQuery` .
Method	getBrokerConstrainerEnablerSearch
Description	Gets a broker constrainer enabler search.
Return	`osid.provisioning.rules.BrokerConstrainerEnablerSearch`		the broker constrainer enabler search
Compliance	`mandatory`		This method must be implemented.
Method	getBrokerConstrainerEnablerSearchOrder
Description	Gets a broker constrainer enabler search order. The `BrokerConstrainerEnablerSearchOrder` is supplied to a `BrokerConstrainerEnablerSearch` to specify the ordering of results.
Return	`osid.provisioning.rules.BrokerConstrainerEnablerSearchOrder`		the broker constrainer enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	getBrokerConstrainerEnablersBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.provisioning.rules.BrokerEnablerQuery`	`brokerConstrainerEnablerQuery`	the broker constrainer enabler query
Parameters	`osid.provisioning.rules.BrokerConstrainerEnablerSearch`	`brokerConstrainerEnablerSearch`	the broker constrainer enabler search
Return	`osid.provisioning.rules.BrokerConstrainerEnablerSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`brokerConstrainerEnablerQuery` or `brokerConstrainerEnablerSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`brokerConstrainerEnablerQuery` or `brokerConstrainerEnablerSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getBrokerConstrainerEnablerQueryFromInspector
Description	Gets a broker constrainer enabler query from an inspector. The inspector is available from a `BrokerConstrainerEnablerSearchResults` .
Parameters	`osid.provisioning.rules.BrokerConstrainerEnablerQueryInspector`	`brokerConstrainerEnablerQueryInspector`	a broker constrainer enabler query inspector
Return	`osid.provisioning.rules.BrokerConstrainerEnablerQuery`		the broker constrainer enabler query
Errors	NULL_ARGUMENT		`brokerConstrainerEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`brokerConstrainerEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.