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

Interface	osid.resourcing.rules.JobConstrainerQuery
Implements	`osid.OsidConstrainerQuery`
Used By	`osid.resourcing.rules.JobConstrainerEnablerQuery`
	`osid.resourcing.rules.JobConstrainerQuerySession`
	`osid.resourcing.rules.JobConstrainerSearchSession`
	`osid.resourcing.rules.JobConstrainerSmartFoundrySession`
Description	This is the query for searching job constrainers. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchRuledJobId
Description	Matches mapped to a job.
Parameters	`osid.id.Id`	`foundryId`	the job `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`foundryId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledJobIdTerms
Description	Clears the job `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsRuledJobQuery
Description	Tests if an `JobQuery` is available.
Return	`boolean`		`true` if a job query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRuledJobQuery
Description	Gets the query for a job. Multiple retrievals produce a nested `OR` term.
Return	`osid.resourcing.JobQuery`		the job query
Errors	UNIMPLEMENTED		`supportsRuledJobQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRuledJobQuery()` is `true`.
Method	matchAnyRuledJob
Description	Matches mapped to any job.
Parameters	`boolean`	`match`	`true` for mapped to any job, `false` to match mapped to no jobs
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledJobTerms
Description	Clears the job query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchFoundryId
Description	Matches mapped to the foundry.
Parameters	`osid.id.Id`	`foundryId`	the foundry `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`foundryId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearFoundryIdTerms
Description	Clears the foundry `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsFoundryQuery
Description	Tests if a `FoundryQuery` is available.
Return	`boolean`		`true` if a foundry query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getFoundryQuery
Description	Gets the query for a foundry. Multiple retrievals produce a nested `OR` term.
Return	`osid.resourcing.FoundryQuery`		the foundry query
Errors	UNIMPLEMENTED		`supportsFoundryQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsFoundryQuery()` is `true`.
Method	clearFoundryTerms
Description	Clears the foundry query terms.
Compliance	`mandatory`		This method must be implemented.
Method	getJobConstrainerQueryRecord
Description	Gets the job constrainer query record corresponding to the given `JobConstrainer` record `Type`. Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`jobConstrainerRecordType`	a job constrainer record type
Return	`osid.resourcing.rules.records.JobConstrainerQueryRecord`		the job constrainer query record
Errors	NULL_ARGUMENT		`jobConstrainerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(jobConstrainerRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.