OSID Specifications
course package
Version 3.1.0
course package
Version 3.1.0
| Interface | osid.course.ActivityQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidRelationshipQueryInspector | ||
osid.OsidSubjugateableQueryInspector | |||
| Used By | osid.course.ActivityQueryInspector | ||
osid.course.ActivitySearchResults | |||
osid.course.ActivitySmartCourseCatalogSession | |||
osid.course.ActivityUnitQueryInspector | |||
osid.course.CourseCatalogQueryInspector | |||
osid.course.CourseOfferingQueryInspector | |||
osid.course.plan.LessonQueryInspector | |||
osid.course.registration.ActivityRegistrationQueryInspector | |||
osid.course.registration.RegistrationTargetQueryInspector | |||
| 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 | getImplicitTerms | ||
| Description |
Gets the implicit terms. | ||
| Return | osid.search.terms.BooleanTerm[] | the implicit 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 | 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 | getMeetingTimeTerms | ||
| Description |
Gets the meeting time query terms. | ||
| Return | osid.search.terms.DateTimeTerm[] | the date query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getMeetingTimeInclusiveTerms | ||
| Description |
Gets the meeting time query terms. | ||
| Return | osid.search.terms.DateTimeRangeTerm[] | the date range query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getMeetingLocationIdTerms | ||
| Description |
Gets the location | ||
| Return | osid.search.terms.IdTerm[] | the location Id query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getMeetingLocationTerms | ||
| Description |
Gets the location query terms. | ||
| Return | osid.mapping.LocationQueryInspector[] | the location query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getScheduleIdTerms | ||
| Description |
Gets the schedule | ||
| Return | osid.search.terms.IdTerm[] | the schedule Id query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getScheduleTerms | ||
| Description |
Gets the schedule query terms. | ||
| Return | osid.calendaring.ScheduleQueryInspector[] | the schedule query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getSupersedingActivityIdTerms | ||
| Description |
Gets the superseding activity | ||
| Return | osid.search.terms.IdTerm[] | the activity Id query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getSupersedingActivityTerms | ||
| Description |
Gets the superseding activity query terms. | ||
| Return | osid.course.ActivityQueryInspector[] | the activity query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getSpecificMeetingTimeTerms | ||
| Description |
Gets the specific meeting time query terms. | ||
| Return | osid.search.terms.DateTimeRangeTerm[] | the date range query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getBlackoutTerms | ||
| Description |
Gets the blackout query terms. | ||
| Return | osid.search.terms.DateTimeTerm[] | the blackout query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getBlackoutInclusiveTerms | ||
| Description |
Gets the inclusive blackout query terms. | ||
| Return | osid.search.terms.DateTimeRangeTerm[] | the blackout query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getInstructorIdTerms | ||
| Description |
Gets the instructor | ||
| Return | osid.search.terms.IdTerm[] | the instructor Id query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getInstructorTerms | ||
| Description |
Gets the instructor query terms. | ||
| Return | osid.resource.ResourceQueryInspector[] | the instructor query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getMinimumSeatsTerms | ||
| Description |
Gets the minimum seating terms. | ||
| Return | osid.search.terms.CardinalRangeTerm[] | the minimum seat query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getMaximumSeatsTerms | ||
| Description |
Gets the maximum seating terms. | ||
| Return | osid.search.terms.CardinalRangeTerm[] | the maximum seat 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 | 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 | getActivityQueryInspectorRecord | ||
| Description |
Gets the activity query inspector record corresponding
to the given | ||
| Parameters | osid.type.Type | activityRecordType | an activity record type |
| Return | osid.course.records.ActivityQueryInspectorRecord | the activity query inspector record | |
| Errors | NULL_ARGUMENT | activityRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(activityRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |