OSID Logo
OSID Specifications
course chronicle package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.chronicle.AssessmentEntryQuery
Implementsosid.OsidRelationshipQuery
Description

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

MethodmatchStudentId
Description

Sets the student 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.
MethodclearStudentIdTerms
Description

Clears the student Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsStudentQuery
Description

Tests if a StudentQuery is available.

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

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

Returnosid.resource.ResourceQuerya student query
ErrorsUNIMPLEMENTED supportsStudentQuery() is false
ComplianceoptionalThis method must be implemented if supportsStudentQuery() is true.
MethodclearStudentTerms
Description

Clears the student option terms.

CompliancemandatoryThis method must be implemented.
MethodmatchAssessmentId
Description

Sets the assessment Id for this query to match entries that have an entry for the given assessment.

Parametersosid.id.IdassessmentIdan assessment Id
booleanmatch true if 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.

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

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

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

Clears the assessment terms.

CompliancemandatoryThis method must be implemented.
MethodmatchDateCompleted
Description

Matches completed dates between the given dates inclusive.

Parametersosid.calendaring.DateTimefromstarting date
osid.calendaring.DateTimetoending date
booleanmatch true if a positive match, false for a negative match
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT from or to is null
CompliancemandatoryThis method must be implemented.
MethodmatchAnyDateCompleted
Description

Matches entries that have any completed date.

Parametersbooleanmatch true to match entries with any completed date, false to match entries with no completed date
CompliancemandatoryThis method must be implemented.
MethodclearDateCompletedTerms
Description

Clears the completed date terms.

CompliancemandatoryThis method must be implemented.
MethodmatchProgramId
Description

Sets the program Id for this query.

Parametersosid.id.IdprogramIda program Id
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT programId is null
CompliancemandatoryThis method must be implemented.
MethodclearProgramIdTerms
Description

Clears the program Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsProgramQuery
Description

Tests if a ProgramQuery is available.

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

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

Returnosid.course.program.ProgramQuerya program query
ErrorsUNIMPLEMENTED supportsProgramQuery() is false
ComplianceoptionalThis method must be implemented if supportsProgramQuery() is true.
MethodmatchAnyProgram
Description

Matches entries that have any program.

Parametersbooleanmatch true to match entries with any program false to match entries with no program
CompliancemandatoryThis method must be implemented.
MethodclearProgramTerms
Description

Clears the program terms.

CompliancemandatoryThis method must be implemented.
MethodmatchCourseId
Description

Sets the course Id for this query.

Parametersosid.id.IdcourseIda course Id
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT courseId is null
CompliancemandatoryThis method must be implemented.
MethodclearCourseIdTerms
Description

Clears the course Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsCourseQuery
Description

Tests if a CourseQuery is available.

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

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

Returnosid.course.CourseQuerya course query
ErrorsUNIMPLEMENTED supportsCourseQuery() is false
ComplianceoptionalThis method must be implemented if supportsCourseQuery() is true.
MethodmatchAnyCourse
Description

Matches entries that have any course.

Parametersbooleanmatch true to match entries with any course, false to match entries with no course
CompliancemandatoryThis method must be implemented.
MethodclearCourseTerms
Description

Clears the course terms.

CompliancemandatoryThis method must be implemented.
MethodmatchGradeId
Description

Matches a grade Id.

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

Clears the grade Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsGradeQuery
Description

Tests if a GradeQuery is available.

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

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

Returnosid.grading.GradeQuerya grade system query
ErrorsUNIMPLEMENTED supportsGradeQuery() is false
ComplianceoptionalThis method must be implemented if supportsGradeQuery() is true.
MethodmatchAnyGrade
Description

Matches entries that have any grade.

Parametersbooleanmatch true to match entries with any grade, false to match entries with no grade
CompliancemandatoryThis method must be implemented.
MethodclearGradeTerms
Description

Clears the grade terms.

CompliancemandatoryThis method must be implemented.
MethodmatchScoreScaleId
Description

Matches a score scale Id.

Parametersosid.id.IdgradeSystemIda grade system Id
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT gradeSystemId is null
CompliancemandatoryThis method must be implemented.
MethodclearScoreScaleIdTerms
Description

Clears the grade system Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsScoreScaleQuery
Description

Tests if a GradeSystemQuery is available.

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

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

Returnosid.grading.GradeSystemQuerya grade system query
ErrorsUNIMPLEMENTED supportsScoreScaleQuery() is false
ComplianceoptionalThis method must be implemented if supportsScoreScaleQuery() is true.
MethodmatchAnyScoreScale
Description

Matches entries that have any score scale.

Parametersbooleanmatch true to match entries with any score scale, false to match entries with no score scale
CompliancemandatoryThis method must be implemented.
MethodclearScoreScaleTerms
Description

Clears the score scale terms.

CompliancemandatoryThis method must be implemented.
MethodmatchScore
Description

Matches scores between the given range inclusive.

Parametersdecimalfromstarting value
decimaltoending value
booleanmatch true if a positive match, false for a negative match
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT from or to is null
CompliancemandatoryThis method must be implemented.
MethodmatchAnyScore
Description

Matches entries that have any score.

Parametersbooleanmatch true to match entries with any score, false to match entries with no score
CompliancemandatoryThis method must be implemented.
MethodclearScoreTerms
Description

Clears the score terms.

CompliancemandatoryThis method must be implemented.
MethodmatchCourseCatalogId
Description

Sets the course catalog Id for this query to match entries assigned to course catalogs.

Parametersosid.id.IdcourseCatalogIdthe course catalog Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT courseCatalogId is null
CompliancemandatoryThis method must be implemented.
MethodclearCourseCatalogIdTerms
Description

Clears the course catalog Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsCourseCatalogQuery
Description

Tests if a CourseCatalogQuery is available.

Returnboolean true if a course catalog query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetCourseCatalogQuery
Description

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

Returnosid.course.CourseCatalogQuerythe course catalog query
ErrorsUNIMPLEMENTED supportsCourseCatalogQuery() is false
ComplianceoptionalThis method must be implemented if supportsCourseCatalogQuery() is true.
MethodclearCourseCatalogTerms
Description

Clears the course catalog terms.

CompliancemandatoryThis method must be implemented.
MethodgetAssessmentEntryQueryRecord
Description

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

Parametersosid.type.TypeassessmentEntryRecordTypean assessment entry record type
Returnosid.course.chronicle.records.AssessmentEntryQueryRecordthe assessment entry query record
ErrorsNULL_ARGUMENT assessmentEntryRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(assessmentEntryRecordType) is false
CompliancemandatoryThis method must be implemented.