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

Interface	osid.resourcing.rules.JobConstrainerSearchSession
Implements	`osid.resourcing.rules.JobConstrainerQuerySession`
Used By	`osid.resourcing.rules.ResourcingRulesManager`
Used By	`osid.resourcing.rules.ResourcingRulesProxyManager`
Description	This session provides methods for searching among `JobConstrainer` objects. The search query is constructed using the `JobConstraineryQuery` . `getJobConstrainersByQuery()` is the basic search method and returns a list of `JobConstrainers` . A more advanced search may be performed with `getJobConstrainersBySearch()` . It accepts a `JobConstrainerSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as resourcing. `getJobConstrainersBySearch()` returns a `JobConstrainerSearchResults` that can be used to access the resulting `JobConstrainerList` or be used to perform a search within the result set through `JobConstrainerSearch` . This session defines views that offer differing behaviors for searching. federated foundry view: searches include job constrainer in foundries of which this foundry is an ancestor in the foundry hierarchy isolated foundry view: searches are restricted to job constrainer in this foundry `JobConstrainers` may have a job constrainer query record indicated by their respective record types. The job constrainer query record is accessed via the `JobConstrainerQuery` .
Method	getJobConstrainerSearch
Description	Gets a job constrainer search.
Return	`osid.resourcing.rules.JobConstrainerSearch`		the job constrainer search
Compliance	`mandatory`		This method must be implemented.
Method	getJobConstrainerSearchOrder
Description	Gets a job constrainer search order. The `JobConstrainerSearchOrder` is supplied to a `JobConstrainerSearch` to specify the ordering of results.
Return	`osid.resourcing.rules.JobConstrainerSearchOrder`		the job constrainer search order
Compliance	`mandatory`		This method must be implemented.
Method	getJobConstrainersBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.resourcing.rules.JobConstrainerQuery`	`jobConstrainerQuery`	the job constrainer query
Parameters	`osid.resourcing.rules.JobConstrainerSearch`	`jobConstrainerSearch`	the job constrainer search
Return	`osid.resourcing.rules.JobConstrainerSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`jobConstrainerQuery` or `jobConstrainerSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`jobConstrainerQuery` or `jobConstrainerSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getJobConstrainerQueryFromInspector
Description	Gets a job constrainer query from an inspector. The inspector is available from a `JobConstrainerSearchResults` .
Parameters	`osid.resourcing.rules.JobConstrainerQueryInspector`	`jobConstrainerQueryInspector`	a job constrainer query inspector
Return	`osid.resourcing.rules.JobConstrainerQuery`		the job constrainer query
Errors	NULL_ARGUMENT		`jobConstrainerQueryInspector` is `null`
Errors	UNSUPPORTED		`jobConstrainerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.