OSID Logo
OSID Specifications
resourcing package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resourcing.JobQuery
Implementsosid.OsidGovernatorQuery
Description

This is the query for searching jobs. Each method match specifies an AND term while multiple invocations of the same method produce a nested OR.

MethodmatchCompetencyId
Description

Sets the competency Id for this query.

Parametersosid.id.IdcompetencyIdthe competency Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT competencyId is null
CompliancemandatoryThis method must be implemented.
MethodclearCompetencyIdTerms
Description

Clears the competency Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsCompetencyQuery
Description

Tests if a CompetencyQuery is available.

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

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

Returnosid.resourcing.CompetencyQuerythe competency query
ErrorsUNIMPLEMENTED supportsCompetencyQuery() is false
ComplianceoptionalThis method must be implemented if supportsCompetencyQuery() is true.
MethodmatchAnyCompetency
Description

Matches work that have any competency.

Parametersbooleanmatch true to match jobs with any competency, false to match work with no competency
CompliancemandatoryThis method must be implemented.
MethodclearCompetencyTerms
Description

Clears the competency query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchWorkId
Description

Sets the work Id for this query.

Parametersosid.id.IdworkIdthe work Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT workId is null
CompliancemandatoryThis method must be implemented.
MethodclearWorkIdTerms
Description

Clears the work Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsWorkQuery
Description

Tests if a WorkQuery is available.

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

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

Returnosid.resourcing.WorkQuerythe work query
ErrorsUNIMPLEMENTED supportsWorkQuery() is false
ComplianceoptionalThis method must be implemented if supportsWorkQuery() is true.
MethodclearWorkTerms
Description

Clears the work query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchAvailabilityId
Description

Sets the availability Id for this query.

Parametersosid.id.IdavailabilityIdthe availability Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT availabilityId is null
CompliancemandatoryThis method must be implemented.
MethodclearAvailabilityIdTerms
Description

Clears the availability Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsAvailabilityQuery
Description

Tests if an AvailabilityQuery is available.

Returnboolean true if an availability query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetAvailabilityQuery
Description

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

Returnosid.resourcing.AvailabilityQuerythe availability query
ErrorsUNIMPLEMENTED supportsAvailabilityQuery() is false
ComplianceoptionalThis method must be implemented if supportsAvailabilityQuery() is true.
MethodmatchAnyAvailability
Description

Matches work that have any availability.

Parametersbooleanmatch true to match work with any availability, false to match work with no availability
CompliancemandatoryThis method must be implemented.
MethodclearAvailabilityTerms
Description

Clears the availability query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchFoundryId
Description

Sets the foundry Id for this query to match jobs assigned to foundries.

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.
MethodgetJobQueryRecord
Description

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

Parametersosid.type.TypejobRecordTypea job record type
Returnosid.resourcing.records.JobQueryRecordthe job query record
ErrorsNULL_ARGUMENT jobRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(jobRecordType) is false
CompliancemandatoryThis method must be implemented.