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

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

MethodgetSteps
Description

Gets the step list resulting from a search.

Returnosid.workflow.StepListthe step list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetStepQueryInspector
Description

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

Returnosid.workflow.StepQueryInspectorthe step query inspector
CompliancemandatoryThis 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.TypestepSearchRecordTypea step search record type
Returnosid.workflow.records.StepSearchResultsRecordthe step search results record
ErrorsNULL_ARGUMENT stepSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(stepSearchRecordType) is false
CompliancemandatoryThis method must be implemented.