OSID Logo
OSID Specifications
workflow rules package
Version 3.1.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.StepEnablerList the step enabler list
ErrorsILLEGAL_STATE list already retrieved
Compliancemandatory This method must be implemented.
MethodgetStepEnablerQueryInspector
Description

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

Returnosid.workflow.rules.StepEnablerQueryInspector the step enabler query inspector
Compliancemandatory This 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.TypestepEnablerSearchRecordType a step enabler search record type
Returnosid.workflow.rules.records.StepEnablerSearchResultsRecord the step enabler search results record
ErrorsNULL_ARGUMENT stepEnablerSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(stepEnablerSearchRecordType) is false
Compliancemandatory This method must be implemented.