OSID Specifications
course registration package
Version 3.1.0
course registration package
Version 3.1.0
| Interface | osid.course.registration.ActivityRegistrationQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidRelationshipQueryInspector | ||
osid.OsidSubjugateableQueryInspector | |||
| Used By | osid.course.registration.ActivityRegistrationSearchResults | ||
osid.course.registration.ActivityRegistrationSmartCourseCatalogSession | |||
| 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 | getCourseRegistrationIdTerms | ||
| Description |
Gets the course registration | ||
| Return | osid.search.terms.IdTerm[] | the course registration Id query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCourseRegistrationTerms | ||
| Description |
Gets the course registration query terms. | ||
| Return | osid.course.registration.CourseRegistrationQueryInspector[] | the course registration 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 | getStudentIdTerms | ||
| Description |
Gets the student | ||
| Return | osid.search.terms.IdTerm[] | the student Id query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getStudentTerms | ||
| Description |
Gets the student query terms. | ||
| Return | osid.resource.ResourceQueryInspector[] | the student 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 | getActivityRegistrationQueryInspectorRecord | ||
| Description |
Gets the activity registration query inspector record
corresponding to the given
| ||
| Parameters | osid.type.Type | activityRegistrationRecordType | an activity registration record type |
| Return | osid.course.registration.records.ActivityRegistrationQueryInspectorRecord | the activity registration query inspector record | |
| Errors | NULL_ARGUMENT | activityRegistrationRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(activityRegistrationRecordType) is
false | ||
| Compliance | mandatory | This method must be implemented. | |