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

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

MethodgetStepProcessors
Description

Gets the StepProcessorList resulting from a search.

Returnosid.workflow.rules.StepProcessorListthe step processor list
ErrorsILLEGAL_STATElist has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetStepProcessorQueryInspector
Description

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

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