Interface | osid.control.TriggerSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getTriggers | ||
Description |
Gets the trigger list resulting from a search. | ||
Return | osid.control.TriggerList | the trigger list | |
Errors | ILLEGAL_STATE | list already retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getTriggerQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.control.TriggerQueryInspector | the trigger query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getTriggerSearchResultsRecord | ||
Description |
Gets the trigger search results record corresponding to
the given trigger search record | ||
Parameters | osid.type.Type | triggerSearchRecordType | a trigger search record type |
Return | osid.control.records.TriggerSearchResultsRecord | the trigger search results record | |
Errors | NULL_ARGUMENT | triggerSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(triggerSearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |