Interface | osid.course.registration.RegistrationSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getRegistrations | ||
Description |
Gets the registration list resulting from a search. | ||
Return | osid.course.registration.RegistrationList | the registration list | |
Errors | ILLEGAL_STATE | the registration list has already been retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getRegistrationQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.course.registration.RegistrationQueryInspector | the query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getRegistrationSearchResultsRecord | ||
Description |
Gets the registration search results record
corresponding to the given registration search record
| ||
Parameters | osid.type.Type | registrationSearchRecordType | a registration search record type |
Return | osid.course.registration.records.RegistrationSearchResultsRecord | the registration search results record | |
Errors | NULL_ARGUMENT | registrationSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(registrationSearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |