OSID Logo
OSID Specifications
resourcing rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resourcing.rules.JobProcessorEnablerQuery
Implementsosid.OsidEnablerQuery
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.

MethodmatchRuledJobProcessorId
Description

Matches enablers mapped to the job processor.

Parametersosid.id.IdjobProcessorIdthe job processor Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT jobProcessorId is null
CompliancemandatoryThis method must be implemented.
MethodclearRuledJobProcessorIdTerms
Description

Clears the job processor Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsRuledJobProcessorQuery
Description

Tests if an JobProcessorQuery is available.

Returnboolean true if a job processor query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetRuledJobProcessorQuery
Description

Gets the query for a job processor. Multiple retrievals produce a nested OR term.

Returnosid.resourcing.rules.JobProcessorQuerythe job processor query
ErrorsUNIMPLEMENTED supportsRuledJobProcessorQuery() is false
ComplianceoptionalThis method must be implemented if supportsRuledJobProcessorQuery() is true.
MethodmatchAnyRuledJobProcessor
Description

Matches enablers mapped to any job processor.

Parametersbooleanmatch true for enablers mapped to any job processor, false to match enablers mapped to no job processors
CompliancemandatoryThis method must be implemented.
MethodclearRuledJobProcessorTerms
Description

Clears the job processor query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchFoundryId
Description

Matches enablers mapped to the foundry.

Parametersosid.id.IdfoundryIdthe foundry Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT foundryId is null
CompliancemandatoryThis method must be implemented.
MethodclearFoundryIdTerms
Description

Clears the foundry Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsFoundryQuery
Description

Tests if a FoundryQuery is available.

Returnboolean true if a foundry query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetFoundryQuery
Description

Gets the query for a foundry. Multiple retrievals produce a nested OR term.

Returnosid.resourcing.FoundryQuerythe foundry query
ErrorsUNIMPLEMENTED supportsFoundryQuery() is false
ComplianceoptionalThis method must be implemented if supportsFoundryQuery() is true.
MethodclearFoundryTerms
Description

Clears the foundry query terms.

CompliancemandatoryThis method must be implemented.
MethodgetJobProcessorEnablerQueryRecord
Description

Gets the job processor enabler query record corresponding to the given JobProcessorEnabler record Type. Multiple record retrievals produce a nested OR term.

Parametersosid.type.TypejobProcessorEnablerRecordTypea job processor enabler record type
Returnosid.resourcing.rules.records.JobProcessorEnablerQueryRecordthe job processor enabler query record
ErrorsNULL_ARGUMENT jobProcessorEnablerRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(jobProcessorEnablerRecordType) is false
CompliancemandatoryThis method must be implemented.