OSID Logo
OSID Specifications
workflow rules package
Version 3.1.0
Interfaceosid.workflow.rules.StepProcessorEnablerSearchResults
Implementsosid.OsidSearchResults
Used Byosid.workflow.rules.StepProcessorEnablerSearchSession
Description

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

MethodgetStepProcessorEnablers
Description

Gets the StepProcessorEnablerList resulting from a search.

Returnosid.workflow.rules.StepProcessorEnablerList the step processor enabler list
ErrorsILLEGAL_STATE list has already been retrieved
Compliancemandatory This method must be implemented.
MethodgetStepProcessorEnablerQueryInspector
Description

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

Returnosid.workflow.rules.StepProcessorEnablerQueryInspector the step processor enabler query inspector
Compliancemandatory This method must be implemented.
MethodgetStepProcessorEnablerSearchResultsRecord
Description

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

Parametersosid.type.TypestepProcessorEnablerSearchRecordType a step processor enabler search record type
Returnosid.workflow.rules.records.StepProcessorEnablerSearchResultsRecord the step processor enabler search results record
ErrorsNULL_ARGUMENT stepProcessorEnablerSearchRecordType is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure occurred
UNSUPPORTED hasRecordType(stepProcessorEnablerSearchRecordType) is false
Compliancemandatory This method must be implemented.