| Interface | osid.course.registration.ActivityRegistrationSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getActivityRegistrations | ||
| Description |
Gets the activity registration list resulting from a search. | ||
| Return | osid.course.registration.ActivityRegistrationList | the activity registration list | |
| Errors | ILLEGAL_STATE | the activity registration list has already been retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getActivityRegistrationQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terms used in the search. | ||
| Return | osid.course.registration.ActivityRegistrationQueryInspector | the query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getActivityRegistrationSearchResultsRecord | ||
| Description |
Gets the activity registration search results record
corresponding to the given activity registration search
record | ||
| Parameters | osid.type.Type | activityRegistrationSearchRecordType | a activity registration search record type |
| Return | osid.course.registration.records.ActivityRegistrationSearchResultsRecord | the activity registration search interface | |
| Errors | NULL_ARGUMENT | activityRegistrationSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(activityRegistrationSearchRecordType) is
false | ||
| Compliance | mandatory | This method must be implemented. | |