| Interface | osid.course.registration.CourseRegistrationSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Used By | osid.course.registration.CourseRegistrationSearchSession | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getCourseRegistrations | ||
| Description |
Gets the course registration list resulting from a search. | ||
| Return | osid.course.registration.CourseRegistrationList | the course registration list | |
| Errors | ILLEGAL_STATE | list already retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCourseRegistrationQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terms used in the search. | ||
| Return | osid.course.registration.CourseRegistrationQueryInspector | the course registration query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCourseRegistrationSearchResultsRecord | ||
| Description |
Gets the course registration search results record
corresponding to the given course registration search
record | ||
| Parameters | osid.type.Type | courseRegistrationSearchRecordType | a course registration search record type |
| Return | osid.course.registration.records.CourseRegistrationSearchResultsRecord | the course registration search results record | |
| Errors | NULL_ARGUMENT | courseRegistrationSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(courseRegistrationSearchRecordTypee) is
false | ||
| Compliance | mandatory | This method must be implemented. | |