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

Interface	osid.resourcing.rules.JobProcessorSearchSession
Implements	`osid.resourcing.rules.JobProcessorQuerySession`
Used By	`osid.resourcing.rules.ResourcingRulesManager`
Used By	`osid.resourcing.rules.ResourcingRulesProxyManager`
Description	This session provides methods for searching among `JobProcessor` objects. The search query is constructed using the `JobProcessoryQuery`. `getJobProcessorsByQuery()` is the basic search method and returns a list of `JobProcessors`. A more advanced search may be performed with `getJobProcessorsBySearch()`.It accepts a `JobProcessorSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as resourcing. `getJobProcessorsBySearch()` returns a `JobProcessorSearchResults` that can be used to access the resulting `JobProcessorList` or be used to perform a search within the result set through `JobProcessorSearch`. This session defines views that offer differing behaviors for searching. federated foundry view: searches include job processor in foundries of which this foundry is an ancestor in the foundry hierarchy isolated foundry view: searches are restricted to job processor in this foundry `JobProcessors` may have a job processor query record indicated by their respective record types. The job processor query record is accessed via the `JobProcessorQuery`. Like all `OsidSessions`, `JobProcessorSearchSessions` are dedicated to single processing threads and a single authenticated user.
Method	getJobProcessorSearch
Description	Gets a job processor search.
Return	`osid.resourcing.rules.JobProcessorSearch`		the job processor search
Compliance	`mandatory`		This method must be implemented.
Method	getJobProcessorSearchOrder
Description	Gets a job processor search order. The `JobProcessorSearchOrder` is supplied to a `JobProcessorSearch` to specify the ordering of results.
Return	`osid.resourcing.rules.JobProcessorSearchOrder`		the job processor search order
Compliance	`mandatory`		This method must be implemented.
Method	getJobProcessorsBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.resourcing.rules.JobProcessorQuery`	`jobProcessorQuery`	the job processor query
Parameters	`osid.resourcing.rules.JobProcessorSearch`	`jobProcessorSearch`	the job processor search
Return	`osid.resourcing.rules.JobProcessorSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`jobProcessorQuery` or `jobProcessorSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`jobProcessorQuery` or `jobProcessorSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getJobProcessorQueryFromInspector
Description	Gets a job processor query from an inspector. The inspector is available from a `JobProcessorSearchResults`.
Parameters	`osid.resourcing.rules.JobProcessorQueryInspector`	`jobProcessorQueryInspector`	a job processor query inspector
Return	`osid.resourcing.rules.JobProcessorQuery`		the job processor query
Errors	NULL_ARGUMENT		`jobProcessorQueryInspector` is `null`
Errors	UNSUPPORTED		`jobProcessorQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.