Interface | osid.learning.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 the search. | ||
Return | osid.learning.ActivityList | the activity list | |
Errors | ILLEGAL_STATE | list already 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.learning.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 | activitiesearchRecordType | an activity search record type |
Return | osid.learning.records.ActivitySearchResultsRecord | the activity search results record | |
Errors | NULL_ARGUMENT | activitiesearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasSearchRecordType(activitiesearchRecordType) is
false | ||
Compliance | mandatory | This method must be implemented. |