OSID Specifications
course package
Version 3.0.0
Release Candidate Preview
course package
Version 3.0.0
Release Candidate Preview
| Interface | osid.course.ActivityUnitQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidObjectQueryInspector | ||
osid.OsidOperableQueryInspector | |||
osid.OsidSubjugateableQueryInspector | |||
| 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 | getTotalTargetEffortTerms | ||
| Description |
Gets the total effort query terms. | ||
| Return | osid.search.terms.DurationRangeTerm[] | the total effort query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getContactTerms | ||
| Description |
Gets the contact query terms. | ||
| Return | osid.search.terms.BooleanTerm[] | the contact query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getTotalTargetContactTimeTerms | ||
| Description |
Gets the total contact time query terms. | ||
| Return | osid.search.terms.DurationRangeTerm[] | the total contact time query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getTotalTargetIndividualEffortTerms | ||
| Description |
Gets the total individual effort query terms. | ||
| Return | osid.search.terms.DurationRangeTerm[] | the total individual effort query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRecurringWeeklyTerms | ||
| Description |
Gets the recurring weekly query terms. | ||
| Return | osid.search.terms.BooleanTerm[] | the recurring weekly query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getWeeklyEffortTerms | ||
| Description |
Gets the weekly effort query terms. | ||
| Return | osid.search.terms.DurationRangeTerm[] | the weekly effort query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getWeeklyContactTimeTerms | ||
| Description |
Gets the weekly contact time query terms. | ||
| Return | osid.search.terms.DurationRangeTerm[] | the weekly contact time query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getWeeklyIndividualEffortTerms | ||
| Description |
Gets the weekly individual effort query terms. | ||
| Return | osid.search.terms.DurationRangeTerm[] | the weekly individual effort query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getLearningObjectiveIdTerms | ||
| Description |
Gets the objective | ||
| Return | osid.search.terms.IdTerm[] | the objective Id query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getLearningObjectiveTerms | ||
| Description |
Gets the objective query terms. | ||
| Return | osid.learning.ObjectiveQueryInspector[] | the objective 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 | 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 | getActivityUnitQueryInspectorRecord | ||
| Description |
Gets the activity unit query inspector record
corresponding to the given | ||
| Parameters | osid.type.Type | activityUnitRecordType | an activity unit record type |
| Return | osid.course.records.ActivityUnitQueryInspectorRecord | the activity unit query inspector record | |
| Errors | NULL_ARGUMENT | activityUnitRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(activityUnitRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |