OSID Logo
OSID Specifications
workflow rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.workflow.rules.StepProcessorEnablerSearchResults
Implementsosid.OsidSearchResults
Description

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

MethodgetStepProcessorEnablers
Description

Gets the StepProcessorEnablerList resulting from a search.

Returnosid.workflow.rules.StepProcessorEnablerListthe step processor enabler list
ErrorsILLEGAL_STATElist has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetStepProcessorEnablerQueryInspector
Description

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

Returnosid.workflow.rules.StepProcessorEnablerQueryInspectorthe step processor enabler query inspector
CompliancemandatoryThis 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.TypestepProcessorEnablerSearchRecordTypea step processor enabler search record type
Returnosid.workflow.rules.records.StepProcessorEnablerSearchResultsRecordthe step processor enabler search results record
ErrorsNULL_ARGUMENT stepProcessorEnablerSearchRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED hasRecordType(stepProcessorEnablerSearchRecordType) is false
CompliancemandatoryThis method must be implemented.