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

MethodmatchRuledJobConstrainerId
Description

Matches enablers mapped to the job constrainer.

Parametersosid.id.IdjobConstrainerIdthe job constrainer Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT jobConstrainerId is null
CompliancemandatoryThis method must be implemented.
MethodclearRuledJobConstrainerIdTerms
Description

Clears the job constrainer Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsRuledJobConstrainerQuery
Description

Tests if an JobConstrainerQuery is available.

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

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

Returnosid.resourcing.rules.JobConstrainerQuerythe job constrainer query
ErrorsUNIMPLEMENTED supportsRuledJobConstrainerQuery() is false
ComplianceoptionalThis method must be implemented if supportsRuledJobConstrainerQuery() is true.
MethodmatchAnyRuledJobConstrainer
Description

Matches enablers mapped to any job constrainer.

Parametersbooleanmatch true for enablers mapped to any job constrainer, false to match enablers mapped to no job constrainers
CompliancemandatoryThis method must be implemented.
MethodclearRuledJobConstrainerTerms
Description

Clears the job constrainer 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.
MethodgetJobConstrainerEnablerQueryRecord
Description

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

Parametersosid.type.TypejobConstrainerEnablerRecordTypea job constrainer enabler record type
Returnosid.resourcing.rules.records.JobConstrainerEnablerQueryRecordthe job constrainer enabler query record
ErrorsNULL_ARGUMENT jobConstrainerEnablerRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(jobConstrainerEnablerRecordType) is false
CompliancemandatoryThis method must be implemented.