OSID Logo
OSID Specifications
workflow rules package
Version 3.1.0
Interfaceosid.workflow.rules.StepProcessorSearchResults
Implementsosid.OsidSearchResults
Used Byosid.workflow.rules.StepProcessorSearchSession
Description

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

MethodgetStepProcessors
Description

Gets the StepProcessorList resulting from a search.

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

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

Returnosid.workflow.rules.StepProcessorQueryInspector the step processor query inspector
Compliancemandatory This method must be implemented.
MethodgetStepProcessorSearchResultsRecord
Description

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

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