Interface | osid.course.chronicle.CourseEntryQuery | ||
---|---|---|---|
Implements | osid.OsidRelationshipQuery | ||
Description |
This is the query for searching course entries. Each method
match specifies an | ||
Method | matchStudentId | ||
Description |
Sets the student | ||
Parameters | osid.id.Id | resourceId | a resource Id |
boolean | match | true if a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | resourceId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearStudentIdTerms | ||
Description |
Clears the student | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsStudentQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a student query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getStudentQuery | ||
Description |
Gets the query for a student option. Multiple
retrievals produce a nested | ||
Return | osid.resource.ResourceQuery | a student query | |
Errors | UNIMPLEMENTED | supportsStudentQuery() is false | |
Compliance | optional | This method must be implemented if supportsStudentQuery() is
true. | |
Method | clearStudentTerms | ||
Description |
Clears the student option terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchCourseId | ||
Description |
Sets the course | ||
Parameters | osid.id.Id | courseId | a course Id |
boolean | match | true if a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | courseId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearCourseIdTerms | ||
Description |
Clears the course | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsCourseQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a course query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getCourseQuery | ||
Description |
Gets the query for a course entry. Multiple retrievals
produce a nested | ||
Return | osid.course.CourseQuery | a course query | |
Errors | UNIMPLEMENTED | supportsCourseQuery() is false | |
Compliance | optional | This method must be implemented if supportsCourseQuery() is
true. | |
Method | clearCourseTerms | ||
Description |
Clears the course terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchTermId | ||
Description |
Sets the term | ||
Parameters | osid.id.Id | termId | a term Id |
boolean | match | true if a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | termId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearTermIdTerms | ||
Description |
Clears the term | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsTermQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a term query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getTermQuery | ||
Description |
Gets the query for a term entry. Multiple retrievals
produce a nested | ||
Return | osid.course.TermQuery | a term query | |
Errors | UNIMPLEMENTED | supportsTermQuery() is false | |
Compliance | optional | This method must be implemented if supportsTermQuery() is
true. | |
Method | clearTermTerms | ||
Description |
Clears the term terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchComplete | ||
Description |
Matches completed courses. | ||
Parameters | boolean | match | true if a positive match, false for a
negative match |
Compliance | mandatory | This method must be implemented. | |
Method | clearCompleteTerms | ||
Description |
Clears the complete terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchCreditScaleId | ||
Description |
Matches a credit scale | ||
Parameters | osid.id.Id | gradeSystemId | a grade system Id |
boolean | match | true if a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | gradeSystemId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearCreditScaleIdTerms | ||
Description |
Clears the grade system | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsCreditScaleQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a grade system query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getCreditScaleQuery | ||
Description |
Gets the query for a grade system. Multiple retrievals
produce a nested | ||
Return | osid.grading.GradeSystemQuery | a grade system query | |
Errors | UNIMPLEMENTED | supportsCreditScaleQuery() is false | |
Compliance | optional | This method must be implemented if supportsCreditScaleQuery()
is true. | |
Method | matchAnyCreditScale | ||
Description |
Matches entries that have any credit scale. | ||
Parameters | boolean | match | true to match entries with any credit scale, false
to match entries with no credit scale |
Compliance | mandatory | This method must be implemented. | |
Method | clearCreditScaleTerms | ||
Description |
Clears the credit scale terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchCreditsEarned | ||
Description |
Matches earned credits between the given range inclusive. | ||
Parameters | decimal | from | starting value |
decimal | to | ending value | |
boolean | match | true if a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | from or to is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchAnyCreditsEarned | ||
Description |
Matches entries that have any earned credits. | ||
Parameters | boolean | match | true to match entries with any earned credits, false
to match entries with no earned credits |
Compliance | mandatory | This method must be implemented. | |
Method | clearCreditsEarnedTerms | ||
Description |
Clears the earned credits terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchGradeId | ||
Description |
Matches a grade | ||
Parameters | osid.id.Id | gradeId | a grade Id |
boolean | match | true if a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | gradeId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearGradeIdTerms | ||
Description |
Clears the grade | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsGradeQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a grade query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getGradeQuery | ||
Description |
Gets the query for a grade. Multiple retrievals produce
a nested | ||
Return | osid.grading.GradeQuery | a grade system query | |
Errors | UNIMPLEMENTED | supportsGradeQuery() is false | |
Compliance | optional | This method must be implemented if supportsGradeQuery() is
true. | |
Method | matchAnyGrade | ||
Description |
Matches entries that have any grade. | ||
Parameters | boolean | match | true to match entries with any grade, false
to match entries with no grade |
Compliance | mandatory | This method must be implemented. | |
Method | clearGradeTerms | ||
Description |
Clears the grade terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchScoreScaleId | ||
Description |
Matches a score scale | ||
Parameters | osid.id.Id | gradeSystemId | a grade system Id |
boolean | match | true if a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | gradeSystemId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearScoreScaleIdTerms | ||
Description |
Clears the grade system | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsScoreScaleQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a grade system query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getScoreScaleQuery | ||
Description |
Gets the query for a grade system. Multiple retrievals
produce a nested | ||
Return | osid.grading.GradeSystemQuery | a grade system query | |
Errors | UNIMPLEMENTED | supportsScoreScaleQuery() is false | |
Compliance | optional | This method must be implemented if supportsScoreScaleQuery()
is true. | |
Method | matchAnyScoreScale | ||
Description |
Matches entries that have any score scale. | ||
Parameters | boolean | match | true to match entries with any score scale, false
to match entries with no score scale |
Compliance | mandatory | This method must be implemented. | |
Method | clearScoreScaleTerms | ||
Description |
Clears the score scale terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchScore | ||
Description |
Matches scores between the given range inclusive. | ||
Parameters | decimal | from | starting value |
decimal | to | ending value | |
boolean | match | true if a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | from or to is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchAnyScore | ||
Description |
Matches entries that have any score. | ||
Parameters | boolean | match | true to match entries with any score, false
to match entries with no score |
Compliance | mandatory | This method must be implemented. | |
Method | clearScoreTerms | ||
Description |
Clears the score terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchRegistrationId | ||
Description |
Sets the enrollment | ||
Parameters | osid.id.Id | enrollmentId | an enrollment Id |
boolean | match | true if a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | enrollmentId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearRegistrationIdTerms | ||
Description |
Clears the registration | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsRegistrationQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a registration query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getRegistrationQuery | ||
Description |
Gets the query for a registration entry. Multiple
retrievals produce a nested | ||
Return | osid.course.registration.RegistrationQuery | a registration query | |
Errors | UNIMPLEMENTED | supportsRegistrationQuery() is false | |
Compliance | optional | This method must be implemented if supportsRegistrationQuery()
is true. | |
Method | matchAnyRegistration | ||
Description |
Matches entries that have any registration. | ||
Parameters | boolean | match | true to match enries with any registration, false
to match enries with no registration |
Compliance | mandatory | This method must be implemented. | |
Method | clearRegistrationTerms | ||
Description |
Clears the registration terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchCourseCatalogId | ||
Description |
Sets the course catalog | ||
Parameters | osid.id.Id | courseCatalogId | the course catalog Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | courseCatalogId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearCourseCatalogIdTerms | ||
Description |
Clears the course catalog | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsCourseCatalogQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a course catalog query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getCourseCatalogQuery | ||
Description |
Gets the query for a course catalog. Multiple
retrievals produce a nested | ||
Return | osid.course.CourseCatalogQuery | the course catalog query | |
Errors | UNIMPLEMENTED | supportsCourseCatalogQuery() is false | |
Compliance | optional | This method must be implemented if supportsCourseCatalogQuery()
is true. | |
Method | clearCourseCatalogTerms | ||
Description |
Clears the course catalog terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCourseEntryQueryRecord | ||
Description |
Gets the course entry query record corresponding to the
given | ||
Parameters | osid.type.Type | courseEntryRecordType | a course entry record type |
Return | osid.course.chronicle.records.CourseEntryQueryRecord | the course entry query record | |
Errors | NULL_ARGUMENT | courseEntryRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(courseEntryRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |