| Interface | osid.course.registration.ActivityBundleSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getActivityBundles | ||
| Description |
Gets the activity bundle list resulting from a search. | ||
| Return | osid.course.registration.ActivityBundleList | the activity bundle list | |
| Errors | ILLEGAL_STATE | the activity bundle list has already been retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getActivityBundleQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terms used in the search. | ||
| Return | osid.course.registration.ActivityBundleQueryInspector | the query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getActivityBundleSearchResultsRecord | ||
| Description |
Gets the activity bundle search results record
corresponding to the given activity bundle search record
| ||
| Parameters | osid.type.Type | activityBundleSearchRecordType | a activity bundle search record type |
| Return | osid.course.registration.records.ActivityBundleSearchResultsRecord | the activity bundle search results record | |
| Errors | NULL_ARGUMENT | activityBundleSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(activityBundleSearchRecordType) is
false | ||
| Compliance | mandatory | This method must be implemented. | |