OSID - osid.resourcing.rules.CommissionEnablerSearchSession Service Interface Definition

Interface	osid.resourcing.rules.CommissionEnablerSearchSession
Implements	`osid.resourcing.rules.CommissionEnablerQuerySession`
Used By	`osid.resourcing.rules.ResourcingRulesManager`
Used By	`osid.resourcing.rules.ResourcingRulesProxyManager`
Description	This session provides methods for searching among `CommissionEnabler` objects. The search query is constructed using the `CommissionEnableryQuery` . `getCommissionEnablersByQuery()` is the basic search method and returns a list of `CommissionEnablers` . A more advanced search may be performed with `getCommissionEnablersBySearch()` . It accepts a `CommissionEnablerSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as resourcing. `getCommissionEnablersBySearch()` returns a `CommissionEnablerSearchResults` that can be used to access the resulting `CommissionEnablerList` or be used to perform a search within the result set through `CommissionEnablerSearch` . This session defines views that offer differing behaviors for searching. federated foundry view: searches include commission enabler in foundries of which this foundry is an ancestor in the foundry hierarchy isolated foundry view: searches are restricted to commission enabler in this foundry `CommissionEnablers` may have a commission enabler query record indicated by their respective record types. The commission enabler query record is accessed via the `CommissionEnablerQuery` .
Method	getCommissionEnablerSearch
Description	Gets a commission enabler search.
Return	`osid.resourcing.rules.CommissionEnablerSearch`		the commission enabler search
Compliance	`mandatory`		This method must be implemented.
Method	getCommissionEnablerSearchOrder
Description	Gets a commission enabler search order. The `CommissionEnablerSearchOrder` is supplied to a `CommissionEnablerSearch` to specify the ordering of results.
Return	`osid.resourcing.rules.CommissionEnablerSearchOrder`		the commission enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	getCommissionEnablersBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.resourcing.rules.CommissionEnablerQuery`	`commissionEnablerQuery`	the commission enabler query
Parameters	`osid.resourcing.rules.CommissionEnablerSearch`	`commissionEnablerSearch`	the commission enabler search
Return	`osid.resourcing.rules.CommissionEnablerSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`commissionEnablerQuery` or `commissionEnablerSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`commissionEnablerQuery` or `commissionEnablerSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getCommissionEnablerQueryFromInspector
Description	Gets a commission enabler query from an inspector. The inspector is available from a `CommissionEnablerSearchResults` .
Parameters	`osid.resourcing.rules.CommissionEnablerQueryInspector`	`ccommissionEnablerQueryInspector`	a commission enabler query inspector
Return	`osid.resourcing.rules.CommissionEnablerQuery`		the commission enabler query
Errors	NULL_ARGUMENT		`commissionEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`commissionEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.