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

Interface	osid.resourcing.rules.JobProcessorEnablerQuery
Implements	`osid.OsidEnablerQuery`
Used By	`osid.resourcing.rules.JobProcessorEnablerQuerySession`
	`osid.resourcing.rules.JobProcessorEnablerSearchSession`
	`osid.resourcing.rules.JobProcessorEnablerSmartFoundrySession`
Description	This is the query for searching job processor enablers. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchRuledJobProcessorId
Description	Matches enablers mapped to the job processor.
Parameters	`osid.id.Id`	`jobProcessorId`	the job processor `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`jobProcessorId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledJobProcessorIdTerms
Description	Clears the job processor `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsRuledJobProcessorQuery
Description	Tests if an `JobProcessorQuery` is available.
Return	`boolean`		`true` if a job processor query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRuledJobProcessorQuery
Description	Gets the query for a job processor. Multiple retrievals produce a nested `OR` term.
Return	`osid.resourcing.rules.JobProcessorQuery`		the job processor query
Errors	UNIMPLEMENTED		`supportsRuledJobProcessorQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRuledJobProcessorQuery()` is `true`.
Method	matchAnyRuledJobProcessor
Description	Matches enablers mapped to any job processor.
Parameters	`boolean`	`match`	`true` for enablers mapped to any job processor, `false` to match enablers mapped to no job processors
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledJobProcessorTerms
Description	Clears the job processor 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	getJobProcessorEnablerQueryRecord
Description	Gets the job processor enabler query record corresponding to the given `JobProcessorEnabler` record `Type`. Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`jobProcessorEnablerRecordType`	a job processor enabler record type
Return	`osid.resourcing.rules.records.JobProcessorEnablerQueryRecord`		the job processor enabler query record
Errors	NULL_ARGUMENT		`jobProcessorEnablerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(jobProcessorEnablerRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.