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

Interface	osid.resourcing.rules.JobProcessorEnablerSearchSession
Implements	`osid.resourcing.rules.JobProcessorEnablerQuerySession`
Used By	`osid.resourcing.rules.ResourcingRulesManager`
Used By	`osid.resourcing.rules.ResourcingRulesProxyManager`
Description	This session provides methods for searching among `JobProcessorEnabler` objects. The search query is constructed using the `JobProcessorEnableryQuery` . `getJobProcessorEnablersByQuery()` is the basic search method and returns a list of `JobProcessorEnablers` . A more advanced search may be performed with `getJobProcessorEnablersBySearch()` . It accepts a `JobProcessorEnablerSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as resourcing. `getJobProcessorEnablersBySearch()` returns a `JobProcessorEnablerSearchResults` that can be used to access the resulting `JobProcessorEnablerList` or be used to perform a search within the result set through `JobProcessorEnablerSearch` . This session defines views that offer differing behaviors for searching. federated foundry view: searches include job processor enablers in foundries of which this foundry is an ancestor in the foundry hierarchy isolated foundry view: searches are restricted to job processor enablers in this foundry `JobProcessorEnablers` may have a query record indicated by their respective record types. The query record is accessed via the `JobProcessorEnablerQuery` .
Method	getJobProcessorEnablerSearch
Description	Gets a job processor enabler search.
Return	`osid.resourcing.rules.JobProcessorEnablerSearch`		the job processor enabler search
Compliance	`mandatory`		This method must be implemented.
Method	getJobProcessorEnablerSearchOrder
Description	Gets a job processor enabler search order. The `JobProcessorEnablerSearchOrder` is supplied to a `JobProcessorEnablerSearch` to specify the ordering of results.
Return	`osid.resourcing.rules.JobProcessorEnablerSearchOrder`		the job processor enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	getJobProcessorEnablersBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.resourcing.rules.JobProcessorEnablerQuery`	`jobProcessorEnablerQuery`	the job processor enabler query
Parameters	`osid.resourcing.rules.JobProcessorEnablerSearch`	`jobProcessorEnablerSearch`	the job processor enabler search
Return	`osid.resourcing.rules.JobProcessorEnablerSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`jobProcessorEnablerQuery` or `jobProcessorEnablerSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`jobProcessorEnablerQuery` or `jobProcessorEnablerSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getJobProcessorEnablerQueryFromInspector
Description	Gets a job processor enabler query from an inspector. The inspector is available from a `JobProcessorEnablerSearchResults` .
Parameters	`osid.resourcing.rules.JobProcessorEnablerQueryInspector`	`jobProcessorEnablerQueryInspector`	a job processor enabler query inspector
Return	`osid.resourcing.rules.JobProcessorEnablerQuery`		the job processor enabler query
Errors	NULL_ARGUMENT		`jobProcessorEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`jobProcessorEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.