OSID Logo
OSID Specifications
control package
Version 3.0.0
Release Candidate Preview
Interfaceosid.control.TriggerSearchResults
Implementsosid.OsidSearchResults
Description

This interface provides a means to capture results of a search.

MethodgetTriggers
Description

Gets the trigger list resulting from a search.

Returnosid.control.TriggerListthe trigger list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetTriggerQueryInspector
Description

Gets the inspector for the query to examine the terms used in the search.

Returnosid.control.TriggerQueryInspectorthe trigger query inspector
CompliancemandatoryThis method must be implemented.
MethodgetTriggerSearchResultsRecord
Description

Gets the trigger search results record corresponding to the given trigger search record Type. This method is used to retrieve an object implementing the requested record.

Parametersosid.type.TypetriggerSearchRecordTypea trigger search record type
Returnosid.control.records.TriggerSearchResultsRecordthe trigger search results record
ErrorsNULL_ARGUMENT triggerSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(triggerSearchRecordType) is false
CompliancemandatoryThis method must be implemented.