OSID Logo
OSID Specifications
resourcing package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resourcing.CompetencyQuery
Implementsosid.OsidObjectQuery
Description

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

MethodmatchLearningObjectiveId
Description

Sets the learning objective Id for this query.

Parametersosid.id.IdobjectiveIdthe learning objective Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT objectiveId is null
CompliancemandatoryThis method must be implemented.
MethodclearLearningObjectiveIdTerms
Description

Clears the learning objective Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsLearningObjectiveQuery
Description

Tests if an ObjectiveQuery is available.

Returnboolean true if a learning objective query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetLearningObjectiveQuery
Description

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

Returnosid.learning.ObjectiveQuerythe learning objective query
ErrorsUNIMPLEMENTED supportsLearningObjectiveQuery() is false
ComplianceoptionalThis method must be implemented if supportsLearningObjectiveQuery() is true.
MethodmatchAnyLearningObjective
Description

Matches competencies that have any learning objective.

Parametersbooleanmatch true to match competencies with any learning objective, false to match competencies with no learning objective
CompliancemandatoryThis method must be implemented.
MethodclearLearningObjectiveTerms
Description

Clears the learning objective 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 competencies that are used in any availability.

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

Clears the availability 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.
MethodmatchAnyWork
Description

Matches competencies that are used in any work.

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

Clears the work query terms.

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

Matches competencies that are used in any job.

Parametersbooleanmatch true to match competencies with any job, false to match competencies with no job
CompliancemandatoryThis method must be implemented.
MethodclearJobTerms
Description

Clears the job query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchFoundryId
Description

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

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

Parametersosid.type.TypecompetencyRecordTypean competency record type
Returnosid.resourcing.records.CompetencyQueryRecordthe competency query record
ErrorsNULL_ARGUMENT competencyRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(competencyRecordType) is false
CompliancemandatoryThis method must be implemented.