OSID Specifications
course plan package
Version 3.0.0
Release Candidate Preview
course plan package
Version 3.0.0
Release Candidate Preview
| Interface | osid.course.plan.LessonQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidRelationshipQueryInspector | ||
| Description |
This is the query inspector for searching for lessons. Each
method specifies an | ||
| Method | getPlanIdTerms | ||
| Description |
Gets the plan | ||
| Return | osid.search.terms.IdTerm[] | the plan Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getPlanTerms | ||
| Description |
Gets the plan terms. | ||
| Return | osid.course.plan.PlanQueryInspector[] | the plan terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDocetIdTerms | ||
| Description |
Gets the docet | ||
| Return | osid.search.terms.IdTerm[] | the docet Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDocetTerms | ||
| Description |
Gets the docet terms. | ||
| Return | osid.course.syllabus.DocetQueryInspector[] | the docet terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getActivityIdTerms | ||
| Description |
Gets the activity | ||
| Return | osid.search.terms.IdTerm[] | the activity Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getActivityTerms | ||
| Description |
Gets the activity terms. | ||
| Return | osid.course.ActivityQueryInspector[] | the activity terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getPlannedStartTimeTerms | ||
| Description |
Gets the planned start time query terms. | ||
| Return | osid.search.terms.DurationRangeTerm[] | the time terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getActualStartTimeTerms | ||
| Description |
Gets actual start time query terms. | ||
| Return | osid.search.terms.DurationRangeTerm[] | the terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getActualStartingActivityIdTerms | ||
| Description |
Gets the starting activity | ||
| Return | osid.search.terms.IdTerm[] | the activity Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getActualStartingActivityTerms | ||
| Description |
Gets the starting activity terms. | ||
| Return | osid.course.ActivityQueryInspector[] | the activity terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCompleteTerms | ||
| Description |
Gets completed query terms. | ||
| Return | osid.search.terms.BooleanTerm[] | the terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getSkippedTerms | ||
| Description |
Gets skipped query terms. | ||
| Return | osid.search.terms.BooleanTerm[] | the terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getActualEndTimeTerms | ||
| Description |
Gets the actual end time query terms. | ||
| Return | osid.search.terms.DurationRangeTerm[] | the time time terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getActualEndingActivityIdTerms | ||
| Description |
Gets the ending activity | ||
| Return | osid.search.terms.IdTerm[] | the activity Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getActualEndingActivityTerms | ||
| Description |
Gets the ending activity terms. | ||
| Return | osid.course.ActivityQueryInspector[] | the activity terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getActualTimeSpentTerms | ||
| Description |
Gets the actual time spent terms. | ||
| Return | osid.search.terms.DurationRangeTerm[] | the duration 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 | getLessonQueryInspectorRecord | ||
| Description |
Gets the query inspector record corresponding to the
given | ||
| Parameters | osid.type.Type | lessonRecordType | a lesson record type |
| Return | osid.course.plan.records.LessonQueryInspectorRecord | the lesson query inspector record | |
| Errors | NULL_ARGUMENT | lessonRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(lessonRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |