OSID Specifications
course chronicle package
Version 3.0.0
Release Candidate Preview
course chronicle package
Version 3.0.0
Release Candidate Preview
| Interface | osid.course.chronicle.CourseEntryQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidRelationshipQueryInspector | ||
| Description |
The query inspectors provide a means of accessing the match
terms of a query. These interfaces are used to examine the
actual query terms used in a search or that may be used to
create a smart catalog. Query inspectors may be converted to
| ||
| Method | getStudentIdTerms | ||
| Description |
Gets the resource | ||
| Return | osid.search.terms.IdTerm[] | the resource Id query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getStudentTerms | ||
| Description |
Gets the student query terms. | ||
| Return | osid.resource.ResourceQueryInspector[] | the resource query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCourseIdTerms | ||
| Description |
Gets the course | ||
| Return | osid.search.terms.IdTerm[] | the course Id query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCourseTerms | ||
| Description |
Gets the course query terms. | ||
| Return | osid.course.CourseQueryInspector[] | the course terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getTermIdTerms | ||
| Description |
Gets the term | ||
| Return | osid.search.terms.IdTerm[] | the term Id query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getTermTerms | ||
| Description |
Gets the term query terms. | ||
| Return | osid.course.TermQueryInspector[] | the term terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCompleteTerms | ||
| Description |
Gets the complete query terms. | ||
| Return | osid.search.terms.BooleanTerm[] | the complete terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCreditScaleIdTerms | ||
| Description |
Gets the grade system | ||
| Return | osid.search.terms.IdTerm[] | the grade system Id query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCreditScaleTerms | ||
| Description |
Gets the grade system query terms. | ||
| Return | osid.grading.GradeSystemQueryInspector[] | the grade system terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCreditsEarnedTerms | ||
| Description |
Gets the earned credits query terms. | ||
| Return | osid.search.terms.DecimalRangeTerm[] | the earned credits query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getGradeIdTerms | ||
| Description |
Gets the grade | ||
| Return | osid.search.terms.IdTerm[] | the grade Id query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getGradeTerms | ||
| Description |
Gets the grade query terms. | ||
| Return | osid.grading.GradeQueryInspector[] | the grade terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getScoreScaleIdTerms | ||
| Description |
Gets the grade system | ||
| Return | osid.search.terms.IdTerm[] | the grade system Id query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getScoreScaleTerms | ||
| Description |
Gets the grade system query terms. | ||
| Return | osid.grading.GradeSystemQueryInspector[] | the grade system terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getScoreTerms | ||
| Description |
Gets the score query terms. | ||
| Return | osid.search.terms.DecimalRangeTerm[] | the score query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRegistrationIdTerms | ||
| Description |
Gets the registration | ||
| Return | osid.search.terms.IdTerm[] | the registration Id query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRegistrationTerms | ||
| Description |
Gets the registration query terms. | ||
| Return | osid.course.registration.RegistrationQueryInspector[] | the registration query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCourseCatalogIdTerms | ||
| Description |
Gets the course catalog | ||
| Return | osid.search.terms.IdTerm[] | the course catalog Id query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCourseCatalogTerms | ||
| Description |
Gets the course catalog query terms. | ||
| Return | osid.course.CourseCatalogQueryInspector[] | the course catalog query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCourseEntryQueryInspectorRecord | ||
| Description |
Gets the course entry query inspector record
corresponding to the given | ||
| Parameters | osid.type.Type | courseEntryRecordType | a course entry record type |
| Return | osid.course.chronicle.records.CourseEntryQueryInspectorRecord | the course entry query inspector 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. | |