OSID Specifications
course plan package
Version 3.1.0
course plan package
Version 3.1.0
| Interface | osid.course.plan.PlanQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidRelationshipQueryInspector | ||
| Used By | osid.course.plan.LessonQueryInspector | ||
osid.course.plan.PlanSearchResults | |||
osid.course.plan.PlanSmartCourseCatalogSession | |||
| Description |
The inspector for examining plan queries. | ||
| Method | getSyllabusIdTerms | ||
| Description |
Gets the syllabus | ||
| Return | osid.search.terms.IdTerm[] | the syllabus Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getSyllabusTerms | ||
| Description |
Gets the syllabus terms. | ||
| Return | osid.course.syllabus.SyllabusQueryInspector[] | the syllabus terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCourseOfferingIdTerms | ||
| Description |
Gets the course offering | ||
| Return | osid.search.terms.IdTerm[] | the course offering Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCourseOfferingTerms | ||
| Description |
Gets the course offering terms. | ||
| Return | osid.course.CourseOfferingQueryInspector[] | the course offering terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getModuleIdTerms | ||
| Description |
Gets the module | ||
| Return | osid.search.terms.IdTerm[] | the module Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getModuleTerms | ||
| Description |
Gets the module terms. | ||
| Return | osid.course.syllabus.ModuleQueryInspector[] | the module terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getLessonIdTerms | ||
| Description |
Gets the lesson | ||
| Return | osid.search.terms.IdTerm[] | the lesson Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getLessonTerms | ||
| Description |
Gets the lesson terms. | ||
| Return | osid.course.plan.LessonQueryInspector[] | the lesson terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCourseCatalogIdTerms | ||
| Description |
Gets the course catalog | ||
| Return | osid.search.terms.IdTerm[] | the course catalog Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCourseCatalogTerms | ||
| Description |
Gets the course catalog terms. | ||
| Return | osid.course.CourseCatalogQueryInspector[] | the course catalog terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getPlanQueryInspectorRecord | ||
| Description |
Gets the plan query inspector record corresponding to
the given | ||
| Parameters | osid.type.Type | planRecordType | a plan record type |
| Return | osid.course.plan.records.PlanQueryInspectorRecord | the plan query inspector record | |
| Errors | NULL_ARGUMENT | planRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(planRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |