Interface | osid.control.rules.ActionEnablerSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getActionEnablers | ||
Description |
Gets the | ||
Return | osid.control.rules.ActionEnablerList | the action enabler list | |
Errors | ILLEGAL_STATE | list has already been retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getActionEnablerQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.control.rules.ActionEnablerQueryInspector | the action enabler query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getActionEnablerSearchResultsRecord | ||
Description |
Gets the action enabler search results record
corresponding to the given action enabler search record
| ||
Parameters | osid.type.Type | actionEnablerSearchRecordType | an action enabler search record type |
Return | osid.control.rules.records.ActionEnablerSearchResultsRecord | the action enabler search results record | |
Errors | NULL_ARGUMENT | actionEnablerSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | hasRecordType(actionEnablerSearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |