Interface | osid.control.TriggerSearchSession | ||
---|---|---|---|
Implements | osid.control.TriggerQuerySession | ||
Description |
This session provides methods for searching among This session defines views that offer differing behaviors for searching.
Triggers may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
Method | getTriggerSearch | ||
Description |
Gets a trigger search. | ||
Return | osid.control.TriggerSearch | the trigger search | |
Compliance | mandatory | This method must be implemented. | |
Method | getTriggerSearchOrder | ||
Description |
Gets a trigger search order. The | ||
Return | osid.control.TriggerSearchOrder | the trigger search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getTriggersBySearch | ||
Description |
Gets the search results matching the given search query using the given search. | ||
Parameters | osid.control.TriggerQuery | triggerQuery | the trigger query |
osid.control.TriggerSearch | triggerSearch | the trigger search | |
Return | osid.control.TriggerSearchResults | the returned search results | |
Errors | NULL_ARGUMENT | triggerQuery or triggerSearch is null
| |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | triggerQuery or triggerSearch is not of this
service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getTriggerQueryFromInspector | ||
Description |
Gets a trigger query from an inspector. The inspector
is available from a | ||
Parameters | osid.control.TriggerQueryInspector | triggerQueryInspector | a trigger query inspector |
Return | osid.control.TriggerQuery | the trigger query | |
Errors | NULL_ARGUMENT | triggerQueryInspector is null | |
UNSUPPORTED | triggerQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |