OSID Logo
OSID Specifications
workflow package
Version 3.1.0
Interfaceosid.workflow.StepSearchResults
Implementsosid.OsidSearchResults
Used Byosid.workflow.StepSearchSession
Description

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

MethodgetSteps
Description

Gets the step list resulting from a search.

Returnosid.workflow.StepList the step list
ErrorsILLEGAL_STATE list already retrieved
Compliancemandatory This method must be implemented.
MethodgetStepQueryInspector
Description

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

Returnosid.workflow.StepQueryInspector the step query inspector
Compliancemandatory This method must be implemented.
MethodgetStepSearchResultsRecord
Description

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

Parametersosid.type.TypestepSearchRecordType a step search record type
Returnosid.workflow.records.StepSearchResultsRecord the step search results record
ErrorsNULL_ARGUMENT stepSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(stepSearchRecordType) is false
Compliancemandatory This method must be implemented.