| Interface | osid.course.registration.RegistrationTargetSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Used By | osid.course.registration.RegistrationTargetSearchSession | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getRegistrationTargets | ||
| Description |
Gets the registration target list resulting from a search. | ||
| Return | osid.course.registration.RegistrationTargetList | the registration target list | |
| Errors | ILLEGAL_STATE | list already retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRegistrationTargetQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terms used in the search. | ||
| Return | osid.course.registration.RegistrationTargetQueryInspector | the registration target query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRegistrationTargetSearchResultsRecord | ||
| Description |
Gets the registration target search results record
corresponding to the given registration target search
record | ||
| Parameters | osid.type.Type | registrationTargetSearchRecordType | a registration target search record type |
| Return | osid.course.registration.records.RegistrationTargetSearchResultsRecord | the registration target search results record | |
| Errors | NULL_ARGUMENT | registrationTargetSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(registrationTargetSearchRecordTypee) is
false | ||
| Compliance | mandatory | This method must be implemented. | |