| Interface | osid.course.registration.request.RegistrationRequestItemSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Used By | osid.course.registration.request.RegistrationRequestItemSearchSession | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getRegistrationRequestItems | ||
| Description |
Gets the registration request item list resulting from a search. | ||
| Return | osid.course.registration.request.RegistrationRequestItemList | the registration request item list | |
| Errors | ILLEGAL_STATE | list already retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRegistrationRequestItemQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terms used in the search. | ||
| Return | osid.course.registration.request.RegistrationRequestItemQueryInspector | the registration request item query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRegistrationRequestItemSearchResultsRecord | ||
| Description |
Gets the registration request item search results
record corresponding to the given registration request
item search record | ||
| Parameters | osid.type.Type | registrationRequestItemSearchRecordType | a registration request item search record type |
| Return | osid.course.registration.request.records.RegistrationRequestItemSearchResultsRecord | the registration request item search results record | |
| Errors | NULL_ARGUMENT | registrationRequestItemSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(registrationRequestItemSearchRecordTypee) is
false | ||
| Compliance | mandatory | This method must be implemented. | |