OSID Logo
OSID Specifications
assessment package
Version 3.0.0
Release Candidate Preview
Interfaceosid.assessment.ItemQuery
Implementsosid.OsidObjectQuery
osid.OsidAggregateableQuery
Description

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

MethodmatchLearningObjectiveId
Description

Sets the learning objective Id for this query.

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

Clears all learning objective Id 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 an item with any objective.

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

Clears all learning objective terms.

CompliancemandatoryThis method must be implemented.
MethodmatchQuestionId
Description

Sets the question Id for this query.

Parametersosid.id.IdquestionIda question Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT questionId is null
CompliancemandatoryThis method must be implemented.
MethodclearQuestionIdTerms
Description

Clears all question Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsQuestionQuery
Description

Tests if a QuestionQuery is available.

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

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

Returnosid.assessment.QuestionQuerythe question query
ErrorsUNIMPLEMENTED supportsQuestionQuery() is false
ComplianceoptionalThis method must be implemented if supportsLearningObjectiveQuery() is true.
MethodmatchAnyQuestion
Description

Matches an item with any question.

Parametersbooleanmatch true to match items with any question, false to match items with no questions
CompliancemandatoryThis method must be implemented.
MethodclearQuestionTerms
Description

Clears all question terms.

CompliancemandatoryThis method must be implemented.
MethodmatchAnswerId
Description

Sets the answer Id for this query.

Parametersosid.id.IdanswerIdan answer Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT answerId is null
CompliancemandatoryThis method must be implemented.
MethodclearAnswerIdTerms
Description

Clears all answer Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsAnswerQuery
Description

Tests if an AnswerQuery is available.

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

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

Returnosid.assessment.AnswerQuerythe answer query
ErrorsUNIMPLEMENTED supportsAnswerQuery() is false
ComplianceoptionalThis method must be implemented if supportsLearningObjectiveQuery() is true.
MethodmatchAnyAnswer
Description

Matches an item with any answer.

Parametersbooleanmatch true to match items with any answer, false to match items with no answers
CompliancemandatoryThis method must be implemented.
MethodclearAnswerTerms
Description

Clears all answer terms.

CompliancemandatoryThis method must be implemented.
MethodmatchAssessmentId
Description

Sets the assessment Id for this query.

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

Clears all assessment Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsAssessmentQuery
Description

Tests if an AssessmentQuery is available.

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 item with any assessment.

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

Clears all assessment terms.

CompliancemandatoryThis method must be implemented.
MethodmatchBankId
Description

Sets the bank Id for this query.

Parametersosid.id.IdbankIda bank Id
booleanmatch true for a positive match, false for negative match
ErrorsNULL_ARGUMENT bankId is null
CompliancemandatoryThis method must be implemented.
MethodclearBankIdTerms
Description

Clears all bank Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsBankQuery
Description

Tests if a BankQuery is available.

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

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

Returnosid.assessment.BankQuerythe bank query
ErrorsUNIMPLEMENTED supportsBankQuery() is false
ComplianceoptionalThis method must be implemented if supportsBankQuery() is true.
MethodclearBankTerms
Description

Clears all bank terms.

CompliancemandatoryThis method must be implemented.
MethodgetItemQueryRecord
Description

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

Parametersosid.type.TypeitemRecordTypean item record type
Returnosid.assessment.records.ItemQueryRecordthe item query record
ErrorsNULL_ARGUMENT itemRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(itemRecordType) is false
CompliancemandatoryThis method must be implemented.