OSID Logo
OSID Specifications
assessment package
Version 3.0.0
Release Candidate Preview
Interfaceosid.assessment.AssessmentQuery
Implementsosid.OsidObjectQuery
Description

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

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 that has any level assigned.

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

Clears all level terms.

CompliancemandatoryThis method must be implemented.
MethodmatchRubricId
Description

Sets the rubric 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.
MethodclearRubricIdTerms
Description

Clears all rubric assessment Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsRubricQuery
Description

Tests if an AssessmentQuery is available.

Returnboolean true if a rubric assessment query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetRubricQuery
Description

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

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

Matches an assessment that has any rubric assessment assigned.

Parametersbooleanmatch true to match assessments with any rubric, false to match assessments with no rubric
CompliancemandatoryThis method must be implemented.
MethodclearRubricTerms
Description

Clears all rubric assessment terms.

CompliancemandatoryThis method must be implemented.
MethodmatchItemId
Description

Sets the item Id for this query.

Parametersosid.id.IditemIdan item Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT itemId is null
CompliancemandatoryThis method must be implemented.
MethodclearItemIdTerms
Description

Clears all item Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsItemQuery
Description

Tests if an ItemQuery is available.

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

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

Returnosid.assessment.ItemQuerythe item query
ErrorsUNIMPLEMENTED supportsItemQuery() is false
ComplianceoptionalThis method must be implemented if supportsItemQuery() is true.
MethodmatchAnyItem
Description

Matches an assessment that has any item.

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

Clears all item terms.

CompliancemandatoryThis method must be implemented.
MethodmatchAssessmentOfferedId
Description

Sets the assessment offered Id for this query.

Parametersosid.id.IdassessmentOfferedIdan assessment offered Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT assessmentOfferedId is null
CompliancemandatoryThis method must be implemented.
MethodclearAssessmentOfferedIdTerms
Description

Clears all assessment offered Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsAssessmentOfferedQuery
Description

Tests if an AssessmentOfferedQuery is available.

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

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

Returnosid.assessment.AssessmentOfferedQuerythe assessment offered query
ErrorsUNIMPLEMENTED supportsAssessmentOfferedQuery() is false
ComplianceoptionalThis method must be implemented if supportsAssessmentOfferedQuery() is true.
MethodmatchAnyAssessmentOffered
Description

Matches an assessment that has any offering.

Parametersbooleanmatch true to match assessments with any offering, false to match assessments with no offerings
CompliancemandatoryThis method must be implemented.
MethodclearAssessmentOfferedTerms
Description

Clears all assessment offered terms.

CompliancemandatoryThis method must be implemented.
MethodmatchAssessmentTakenId
Description

Sets the assessment taken Id for this query.

Parametersosid.id.IdassessmentTakenIdan assessment taken Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT assessmentTakenId is null
CompliancemandatoryThis method must be implemented.
MethodclearAssessmentTakenIdTerms
Description

Clears all assessment taken Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsAssessmentTakenQuery
Description

Tests if an AssessmentTakenQuery is available.

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

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

Returnosid.assessment.AssessmentTakenQuerythe assessment taken query
ErrorsUNIMPLEMENTED supportsAssessmentTakenQuery() is false
ComplianceoptionalThis method must be implemented if supportsAssessmentTakenQuery() is true.
MethodmatchAnyAssessmentTaken
Description

Matches an assessment that has any taken version.

Parametersbooleanmatch true to match assessments with any taken assessments, false to match assessments with no taken assessments
CompliancemandatoryThis method must be implemented.
MethodclearAssessmentTakenTerms
Description

Clears all assessment taken 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 a 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.
MethodgetAssessmentQueryRecord
Description

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

Parametersosid.type.TypeassessmentRecordTypean assessment record type
Returnosid.assessment.records.AssessmentQueryRecordthe assessment query record
ErrorsNULL_ARGUMENT assessmentRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(assessmentRecordType) is false
CompliancemandatoryThis method must be implemented.