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

This is the query for searching course 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.
MethodmatchCourseId
Description

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

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

Clears the course terms.

CompliancemandatoryThis method must be implemented.
MethodmatchTermId
Description

Sets the term Id for this query.

Parametersosid.id.IdtermIda term Id
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT termId is null
CompliancemandatoryThis method must be implemented.
MethodclearTermIdTerms
Description

Clears the term Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsTermQuery
Description

Tests if a TermQuery is available.

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

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

Returnosid.course.TermQuerya term query
ErrorsUNIMPLEMENTED supportsTermQuery() is false
ComplianceoptionalThis method must be implemented if supportsTermQuery() is true.
MethodclearTermTerms
Description

Clears the term terms.

CompliancemandatoryThis method must be implemented.
MethodmatchComplete
Description

Matches completed courses.

Parametersbooleanmatch true if a positive match, false for a negative match
CompliancemandatoryThis method must be implemented.
MethodclearCompleteTerms
Description

Clears the complete terms.

CompliancemandatoryThis method must be implemented.
MethodmatchCreditScaleId
Description

Matches a credit 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.
MethodclearCreditScaleIdTerms
Description

Clears the grade system Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsCreditScaleQuery
Description

Tests if a GradeSystemQuery is available.

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

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

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

Matches entries that have any credit scale.

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

Clears the credit scale terms.

CompliancemandatoryThis method must be implemented.
MethodmatchCreditsEarned
Description

Matches earned credits 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.
MethodmatchAnyCreditsEarned
Description

Matches entries that have any earned credits.

Parametersbooleanmatch true to match entries with any earned credits, false to match entries with no earned credits
CompliancemandatoryThis method must be implemented.
MethodclearCreditsEarnedTerms
Description

Clears the earned credits 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.
MethodmatchRegistrationId
Description

Sets the enrollment Id for this query.

Parametersosid.id.IdenrollmentIdan enrollment Id
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT enrollmentId is null
CompliancemandatoryThis method must be implemented.
MethodclearRegistrationIdTerms
Description

Clears the registration Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsRegistrationQuery
Description

Tests if a RegistrationQuery is available.

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

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

Returnosid.course.registration.RegistrationQuerya registration query
ErrorsUNIMPLEMENTED supportsRegistrationQuery() is false
ComplianceoptionalThis method must be implemented if supportsRegistrationQuery() is true.
MethodmatchAnyRegistration
Description

Matches entries that have any registration.

Parametersbooleanmatch true to match enries with any registration, false to match enries with no registration
CompliancemandatoryThis method must be implemented.
MethodclearRegistrationTerms
Description

Clears the registration 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.
MethodgetCourseEntryQueryRecord
Description

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

Parametersosid.type.TypecourseEntryRecordTypea course entry record type
Returnosid.course.chronicle.records.CourseEntryQueryRecordthe course entry query record
ErrorsNULL_ARGUMENT courseEntryRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(courseEntryRecordType) is false
CompliancemandatoryThis method must be implemented.