Interface | osid.control.ActionGroupSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getActionGroups | ||
Description |
Gets the action group list resulting from a search. | ||
Return | osid.control.ActionGroupList | the action group list | |
Errors | ILLEGAL_STATE | list already retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getActionGroupQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.control.ActionGroupQueryInspector | the action group query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getActionGroupSearchResultsRecord | ||
Description |
Gets the action group search results record
corresponding to the given action group search record
| ||
Parameters | osid.type.Type | actionGroupSearchRecordType | an action group search record type |
Return | osid.control.records.ActionGroupSearchResultsRecord | the action group search results record | |
Errors | NULL_ARGUMENT | actionGroupSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(actionGroupSearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |