| Interface | osid.course.ActivitySearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getActivities | ||
| Description |
Gets the activity list resulting from a search. | ||
| Return | osid.course.ActivityList | the activity list | |
| Errors | ILLEGAL_STATE | the activity list has already been retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getActivityQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terms used in the search. | ||
| Return | osid.course.ActivityQueryInspector | the query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getActivitySearchResultsRecord | ||
| Description |
Gets the activity search results record corresponding
to the given activity search record | ||
| Parameters | osid.type.Type | activitySearchRecordType | a activity search record type |
| Return | osid.course.records.ActivitySearchResultsRecord | the activity search interface | |
| Errors | NULL_ARGUMENT | activitySearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(activitySearchRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |