OSID Specifications
course package
Version 3.0.0
Release Candidate Preview
course package
Version 3.0.0
Release Candidate Preview
| Interface | osid.course.CourseCatalogQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidCatalogQueryInspector | ||
| 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 | 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 query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getActivityUnitIdTerms | ||
| Description |
Gets the activity unit | ||
| Return | osid.search.terms.IdTerm[] | the activity unit Id query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getActivityUnitTerms | ||
| Description |
Gets the activity unit query terms. | ||
| Return | osid.course.ActivityUnitQueryInspector[] | the activity unit query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCourseOfferingIdTerms | ||
| Description |
Gets the course offering | ||
| Return | osid.search.terms.IdTerm[] | the course offering Id query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCourseOfferingTerms | ||
| Description |
Gets the course offering query terms. | ||
| Return | osid.course.CourseOfferingQueryInspector[] | the course offering query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getActivityIdTerms | ||
| Description |
Gets the activity | ||
| Return | osid.search.terms.IdTerm[] | the activity Id query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getActivityTerms | ||
| Description |
Gets the activity query terms. | ||
| Return | osid.course.ActivityQueryInspector[] | the activity query 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 query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAncestorCourseCatalogIdTerms | ||
| Description |
Gets the ancestor course catalog | ||
| Return | osid.search.terms.IdTerm[] | the ancestor course catalog Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAncestorCourseCatalogTerms | ||
| Description |
Gets the ancestor course catalog query terms. | ||
| Return | osid.course.CourseCatalogQueryInspector[] | the ancestor course catalog terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDescendantCourseCatalogIdTerms | ||
| Description |
Gets the descendant course catalog | ||
| Return | osid.search.terms.IdTerm[] | the descendant course catalog Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDescendantCourseCatalogTerms | ||
| Description |
Gets the descendant course catalog query terms. | ||
| Return | osid.course.CourseCatalogQueryInspector[] | the descendant course catalog terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCourseCatalogQueryInspectorRecord | ||
| Description |
Gets the course catalog query inspector record
corresponding to the given | ||
| Parameters | osid.type.Type | courseCatalogRecordType | a course catalog record type |
| Return | osid.course.records.CourseCatalogQueryInspectorRecord | the course catalog query inspector record | |
| Errors | NULL_ARGUMENT | courseCatalogRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(courseCatalogRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |