Interface | osid.course.ActivityUnitSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getActivityUnits | ||
Description |
Gets the activity unit list resulting from a search. | ||
Return | osid.course.ActivityUnitList | the activity unit list | |
Errors | ILLEGAL_STATE | the activity unit list has already been retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getActivityUnitQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.course.ActivityUnitQueryInspector | the query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getActivityUnitSearchResultsRecord | ||
Description |
Gets the activity unit search results record
corresponding to the given activity unit search record
| ||
Parameters | osid.type.Type | activityUnitSearchRecordType | a activity unit search record type |
Return | osid.course.records.ActivityUnitSearchResultsRecord | the activity unit search results record | |
Errors | NULL_ARGUMENT | activityUnitSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(activityUnitSearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |