OSID Logo
OSID Specifications
learning package
Version 3.0.0
Release Candidate Preview
Interfaceosid.learning.ObjectiveQuery
Implementsosid.OsidObjectQuery
osid.OsidFederateableQuery
Description

This is the query for searching objectives. Each method match request produces an AND term while multiple invocations of a method produces a nested OR.

MethodmatchAssessmentId
Description

Sets the assessment Id for this query.

Parametersosid.id.IdassessmentIdan assessment Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT assessmentId is null
CompliancemandatoryThis method must be implemented.
MethodclearAssessmentIdTerms
Description

Clears the assessment Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsAssessmentQuery
Description

Tests if an AssessmentQuery is available for querying activities.

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

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

Returnosid.assessment.AssessmentQuerythe assessment query
ErrorsUNIMPLEMENTED supportsAssessmentQuery() is false
ComplianceoptionalThis method must be implemented if supportsAssessmentQuery() is true.
MethodmatchAnyAssessment
Description

Matches an objective that has any assessment assigned.

Parametersbooleanmatch true to match objectives with any assessment, false to match objectives with no assessment
CompliancemandatoryThis method must be implemented.
MethodclearAssessmentTerms
Description

Clears the assessment terms.

CompliancemandatoryThis method must be implemented.
MethodmatchKnowledgeCategoryId
Description

Sets the knowledge category 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.
MethodclearKnowledgeCategoryIdTerms
Description

Clears the knowledge category Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsKnowledgeCategoryQuery
Description

Tests if a GradeQuery is available for querying knowledge categories.

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

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

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

Matches an objective that has any knowledge category.

Parametersbooleanmatch true to match objectives with any knowledge category, false to match objectives with no knowledge category
CompliancemandatoryThis method must be implemented.
MethodclearKnowledgeCategoryTerms
Description

Clears the knowledge category terms.

CompliancemandatoryThis method must be implemented.
MethodmatchCognitiveProcessId
Description

Sets the cognitive process 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.
MethodclearCognitiveProcessIdTerms
Description

Clears the cognitive process Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsCognitiveProcessQuery
Description

Tests if a GradeQuery is available for querying cognitive processes.

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

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

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

Matches an objective that has any cognitive process.

Parametersbooleanmatch true to match objectives with any cognitive process, false to match objectives with no cognitive process
CompliancemandatoryThis method must be implemented.
MethodclearCognitiveProcessTerms
Description

Clears the cognitive process terms.

CompliancemandatoryThis method must be implemented.
MethodmatchActivityId
Description

Sets the activity Id for this query.

Parametersosid.id.IdactivityIdan activity Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT activityId is null
CompliancemandatoryThis method must be implemented.
MethodclearActivityIdTerms
Description

Clears the activity Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsActivityQuery
Description

Tests if an ActivityQuery is available for querying activities.

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

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

Returnosid.learning.ActivityQuerythe activity query
ErrorsUNIMPLEMENTED supportsActivityQuery() is false
ComplianceoptionalThis method must be implemented if supportsActivityQuery() is true.
MethodmatchAnyActivity
Description

Matches an objective that has any related activity.

Parametersbooleanmatch true to match objectives with any activity, false to match objectives with no activity
CompliancemandatoryThis method must be implemented.
MethodclearActivityTerms
Description

Clears the activity terms.

CompliancemandatoryThis method must be implemented.
MethodmatchRequisiteObjectiveId
Description

Sets the requisite objective Id for this query.

Parametersosid.id.IdrequisiteObjectiveIda requisite objective Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT requisiteObjectiveId is null
CompliancemandatoryThis method must be implemented.
MethodclearRequisiteObjectiveIdTerms
Description

Clears the requisite objective Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsRequisiteObjectiveQuery
Description

Tests if an ObjectiveQuery is available for querying requisite objectives.

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

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

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

Matches an objective that has any related requisite.

Parametersbooleanmatch true to match objectives with any requisite, false to match objectives with no requisite
CompliancemandatoryThis method must be implemented.
MethodclearRequisiteObjectiveTerms
Description

Clears the requisite objective terms.

CompliancemandatoryThis method must be implemented.
MethodmatchDependentObjectiveId
Description

Sets the dependent objective Id to query objectives dependent on the given objective.

Parametersosid.id.IddependentObjectiveIda dependent objective Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT dependentObjectiveId is null
CompliancemandatoryThis method must be implemented.
MethodclearDependentObjectiveIdTerms
Description

Clears the dependent objective Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsDepndentObjectiveQuery
Description

Tests if an ObjectiveQuery is available for querying dependent objectives.

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

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

Returnosid.learning.ObjectiveQuerythe objective query
ErrorsUNIMPLEMENTED supportsDependentObjectiveQuery() is false
ComplianceoptionalThis method must be implemented if supportsDependentQuery() is true.
MethodmatchAnyDependentObjective
Description

Matches an objective that has any related dependents.

Parametersbooleanmatch true to match objectives with any dependent, false to match objectives with no dependents
CompliancemandatoryThis method must be implemented.
MethodclearDependentObjectiveTerms
Description

Clears the dependent objective terms.

CompliancemandatoryThis method must be implemented.
MethodmatchEquivalentObjectiveId
Description

Sets the equivalent objective Id to query equivalents.

Parametersosid.id.IdequivalentObjectiveIdan equivalent objective Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT equivalentObjectiveId is null
CompliancemandatoryThis method must be implemented.
MethodclearEquivalentObjectiveIdTerms
Description

Clears the equivalent objective Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsEquivalentObjectiveQuery
Description

Tests if an ObjectiveQuery is available for querying equivalent objectives.

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

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

Returnosid.learning.ObjectiveQuerythe objective query
ErrorsUNIMPLEMENTED supportsEquivalentObjectiveQuery() is false
ComplianceoptionalThis method must be implemented if supportsEquivalentQuery() is true.
MethodmatchAnyEquivalentObjective
Description

Matches an objective that has any related equivalents.

Parametersbooleanmatch true to match objectives with any equivalent, false to match objectives with no equivalents
CompliancemandatoryThis method must be implemented.
MethodclearEquivalentObjectiveTerms
Description

Clears the equivalent objective terms.

CompliancemandatoryThis method must be implemented.
MethodmatchAncestorObjectiveId
Description

Sets the objective Id for this query to match objectives that have the specified objective as an ancestor.

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

Clears the ancestor objective Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsAncestorObjectiveQuery
Description

Tests if an ObjectiveQuery is available.

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

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

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

Matches objectives that have any ancestor.

Parametersbooleanmatch true to match objective with any ancestor, false to match root objectives
CompliancemandatoryThis method must be implemented.
MethodclearAncestorObjectiveTerms
Description

Clears the ancestor objective query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchDescendantObjectiveId
Description

Sets the objective Id for this query to match objectives that have the specified objective as a descendant.

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

Clears the descendant objective Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsDescendantObjectiveQuery
Description

Tests if an ObjectiveQuery is available.

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

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

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

Matches objectives that have any ancestor.

Parametersbooleanmatch true to match objectives with any ancestor, false to match leaf objectives
CompliancemandatoryThis method must be implemented.
MethodclearDescendantObjectiveTerms
Description

Clears the descendant objective query 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 objective banks.

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

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

Parametersosid.type.TypeobjectiveRecordTypean objective query record type
Returnosid.learning.records.ObjectiveQueryRecordthe objective query record
ErrorsNULL_ARGUMENT objectiveRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(objectiveRecordType) is false
CompliancemandatoryThis method must be implemented.