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

Interface	osid.resourcing.rules.JobConstrainerEnablerQuery
Implements	`osid.OsidEnablerQuery`
Used By	`osid.resourcing.rules.JobConstrainerEnablerQuerySession`
	`osid.resourcing.rules.JobConstrainerEnablerSearchSession`
	`osid.resourcing.rules.JobConstrainerEnablerSmartFoundrySession`
Description	This is the query for searching job constrainer enablers. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchRuledJobConstrainerId
Description	Matches enablers mapped to the job constrainer.
Parameters	`osid.id.Id`	`jobConstrainerId`	the job constrainer `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`jobConstrainerId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledJobConstrainerIdTerms
Description	Clears the job constrainer `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsRuledJobConstrainerQuery
Description	Tests if an `JobConstrainerQuery` is available.
Return	`boolean`		`true` if a job constrainer query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRuledJobConstrainerQuery
Description	Gets the query for a job constrainer. Multiple retrievals produce a nested `OR` term.
Return	`osid.resourcing.rules.JobConstrainerQuery`		the job constrainer query
Errors	UNIMPLEMENTED		`supportsRuledJobConstrainerQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRuledJobConstrainerQuery()` is `true`.
Method	matchAnyRuledJobConstrainer
Description	Matches enablers mapped to any job constrainer.
Parameters	`boolean`	`match`	`true` for enablers mapped to any job constrainer, `false` to match enablers mapped to no job constrainers
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledJobConstrainerTerms
Description	Clears the job constrainer query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchFoundryId
Description	Matches enablers 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	getJobConstrainerEnablerQueryRecord
Description	Gets the job constrainer enabler query record corresponding to the given `JobConstrainerEnabler` record `Type`. Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`jobConstrainerEnablerRecordType`	a job constrainer enabler record type
Return	`osid.resourcing.rules.records.JobConstrainerEnablerQueryRecord`		the job constrainer enabler query record
Errors	NULL_ARGUMENT		`jobConstrainerEnablerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(jobConstrainerEnablerRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.