OSID Logo
OSID Specifications
learning package
Version 3.0.0
Release Candidate Preview
Interfaceosid.learning.ProficiencyQuery
Implementsosid.OsidRelationshipQuery
Description

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

MethodmatchResourceId
Description

Sets the resource Id for this query.

Parametersosid.id.IdresourceIda resource Id
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT resourceId is null
CompliancemandatoryThis method must be implemented.
MethodclearResourceIdTerms
Description

Clears the resource Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsResourceQuery
Description

Tests if a ResourceQuery is available.

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

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

Returnosid.resource.ResourceQuerythe resource query
ErrorsUNIMPLEMENTED supportsResourceQuery() is false
ComplianceoptionalThis method must be implemented if supportsResourceQuery() is true.
MethodclearResourceTerms
Description

Clears the resource terms.

CompliancemandatoryThis method must be implemented.
MethodmatchObjectiveId
Description

Sets the objective Id for this query.

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

Clears the objective Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsObjectiveQuery
Description

Tests if an ObjectiveQuery is available for querying objectives.

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

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

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

Matches an activity that has any objective assigned.

Parametersbooleanmatch true to match activities with any objective, false to match activities with no objective
CompliancemandatoryThis method must be implemented.
MethodclearObjectiveTerms
Description

Clears the objective terms.

CompliancemandatoryThis method must be implemented.
MethodmatchCompletion
Description

Sets the completion for this query to match completion percentages between the given range inclusive.

Parametersdecimalstartstart of range
decimalendend of range
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT end is less than start
CompliancemandatoryThis method must be implemented.
MethodclearCompletionTerms
Description

Clears the completion terms.

CompliancemandatoryThis method must be implemented.
MethodmatchMinimumCompletion
Description

Sets the minimum completion for this query.

Parametersdecimalcompletioncompletion percentage
booleanmatch true for a positive match, false for a negative match
CompliancemandatoryThis method must be implemented.
MethodclearMinimumCompletionTerms
Description

Clears the minimum completion terms.

CompliancemandatoryThis method must be implemented.
MethodmatchLevelId
Description

Sets the level grade Id for this query.

Parametersosid.id.IdgradeIda grade Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT gradeId is null
CompliancemandatoryThis method must be implemented.
MethodclearLevelIdTerms
Description

Clears all level Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsLevelQuery
Description

Tests if a GradeQuery is available.

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

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

Returnosid.grading.GradeQuerythe grade query
ErrorsUNIMPLEMENTED supportsLevelQuery() is false
ComplianceoptionalThis method must be implemented if supportsLevelQuery() is true.
MethodmatchAnyLevel
Description

Matches an assessment offered that has any level assigned.

Parametersbooleanmatch true to match offerings with any level, false to match offerings with no levsls
CompliancemandatoryThis method must be implemented.
MethodclearLevelTerms
Description

Clears all level terms.

CompliancemandatoryThis method must be implemented.
MethodmatchObjectiveBankId
Description

Sets the objective bank Id for this query.

Parametersosid.id.IdobjectiveBankIdan objective bank Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT objectiveBankId is null
CompliancemandatoryThis method must be implemented.
MethodclearObjectiveBankIdTerms
Description

Clears the objective bank Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsObjectiveBankQuery
Description

Tests if a ObjectiveBankQuery is available for querying resources.

Returnboolean true if an objective bank query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetObjectiveBankQuery
Description

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

Returnosid.learning.ObjectiveBankQuerythe objective bank query
ErrorsUNIMPLEMENTED supportsObjectiveBankQuery() is false
ComplianceoptionalThis method must be implemented if supportsObjectiveBankQuery() is true.
MethodclearObjectiveBankTerms
Description

Clears the objective bank terms.

CompliancemandatoryThis method must be implemented.
MethodgetProficiencyQueryRecord
Description

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

Parametersosid.type.TypeproficiencyRecordTypea proficiency offered record type
Returnosid.learning.records.ProficiencyQueryRecordthe proficiency offered query record
ErrorsNULL_ARGUMENT proficiencyOfferedRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(proficiencyOfferedRecordType) is false
CompliancemandatoryThis method must be implemented.