OSID Logo
OSID Specifications
resourcing package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resourcing.WorkQuery
Implementsosid.OsidObjectQuery
osid.OsidSubjugateableQuery
Description

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

MethodmatchJobId
Description

Sets the job Id for this query.

Parametersosid.id.IdjobIdthe job Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT jobId is null
CompliancemandatoryThis method must be implemented.
MethodclearJobIdTerms
Description

Clears the job Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsJobQuery
Description

Tests if a JobQuery is available.

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

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

Returnosid.resourcing.JobQuerythe job query
ErrorsUNIMPLEMENTED supportsJobQuery() is false
ComplianceoptionalThis method must be implemented if supportsJobQuery() is true.
MethodclearJobTerms
Description

Clears the job query terms.

CompliancemandatoryThis method must be implemented.
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 work 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.
MethodmatchCreatedDate
Description

Matches the creation date between the given date range inclusive.

Parametersosid.calendaring.DateTimestartstart of date range
osid.calendaring.DateTimeendend of date range
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT start is greater than end
NULL_ARGUMENT start or end is null
CompliancemandatoryThis method must be implemented.
MethodclearCreatedDateTerms
Description

Clears the creation date query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchCompletionDate
Description

Matches the completion date between the given date range inclusive.

Parametersosid.calendaring.DateTimestartstart of date range
osid.calendaring.DateTimeendend of date range
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT start is greater than end
NULL_ARGUMENT start or end is null
CompliancemandatoryThis method must be implemented.
MethodmatchAnyCompletionDate
Description

Matches work that have any completion date.

Parametersbooleanmatch true to match completed work, false to match incomplete work
CompliancemandatoryThis method must be implemented.
MethodclearCompletionDateTerms
Description

Clears the completion date query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchCommissionId
Description

Sets the commission Id for this query to match commissions.

Parametersosid.id.IdcommissionIdthe availability Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT commissionId is null
CompliancemandatoryThis method must be implemented.
MethodclearCommissionIdTerms
Description

Clears the commission Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsAvailabilityQuery
Description

Tests if a CommissionQuery is available.

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

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

Returnosid.resourcing.CommissionQuerythe commission query
ErrorsUNIMPLEMENTED supportsCommissionQuery() is false
ComplianceoptionalThis method must be implemented if supportsCommissionQuery() is true.
MethodmatchAnyCommission
Description

Matches work that have any commission.

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

Clears the commission query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchFoundryId
Description

Sets the foundry Id for this query to match works 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.
MethodgetWorkQueryRecord
Description

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

Parametersosid.type.TypeworkRecordTypea work record type
Returnosid.resourcing.records.WorkQueryRecordthe work query record
ErrorsNULL_ARGUMENT workRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(workRecordType) is false
CompliancemandatoryThis method must be implemented.