| Interface | osid.course.registration.request.RegistrationRequestSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Used By | osid.course.registration.request.RegistrationRequestSearchSession | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getRegistrationRequests | ||
| Description |
Gets the registration request list resulting from a search. | ||
| Return | osid.course.registration.request.RegistrationRequestList | the registration request list | |
| Errors | ILLEGAL_STATE | list already retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRegistrationRequestQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terms used in the search. | ||
| Return | osid.course.registration.request.RegistrationRequestQueryInspector | the registration request query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRegistrationRequestSearchResultsRecord | ||
| Description |
Gets the registration request search results record
corresponding to the given registration request search
record | ||
| Parameters | osid.type.Type | registrationRequestSearchRecordType | a registration request search record type |
| Return | osid.course.registration.request.records.RegistrationRequestSearchResultsRecord | the registration request search results record | |
| Errors | NULL_ARGUMENT | registrationRequestSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(registrationRequestSearchRecordTypee) is
false | ||
| Compliance | mandatory | This method must be implemented. | |