OSID Logo
OSID Specifications
workflow rules package
Version 3.0.0
Interfaceosid.workflow.rules.StepEnablerSearchResults
Implementsosid.OsidSearchResults
Used Byosid.workflow.rules.StepEnablerSearchSession
Description

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

MethodgetStepEnablers
Description

Gets the step enabler list resulting from a search.

Returnosid.workflow.rules.StepEnablerListthe step enabler list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetStepEnablerQueryInspector
Description

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

Returnosid.workflow.rules.StepEnablerQueryInspectorthe step enabler query inspector
CompliancemandatoryThis method must be implemented.
MethodgetStepEnablerSearchResultsRecord
Description

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

Parametersosid.type.TypestepEnablerSearchRecordTypea step enabler search record type
Returnosid.workflow.rules.records.StepEnablerSearchResultsRecordthe step enabler search results record
ErrorsNULL_ARGUMENTstepEnablerSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTEDhasRecordType(stepEnablerSearchRecordType) is false
CompliancemandatoryThis method must be implemented.