OSID Logo
OSID Specifications
workflow package
Version 3.0.0
Release Candidate Preview
Interfaceosid.workflow.StepSearch
Implementsosid.OsidSearch
Description

The search interface for governing step searches.

MethodsearchAmongSteps
Description

Execute this search among the given list of steps.

Parametersosid.id.IdListstepIdslist of steps
ErrorsNULL_ARGUMENT stepIds is null
CompliancemandatoryThis method must be implemented.
MethodorderStepResults
Description

Specify an ordering to the search results.

Parametersosid.workflow.StepSearchOrderstepSearchOrderstep search order
ErrorsNULL_ARGUMENT stepSearchOrder is null
UNSUPPORTED stepSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetStepSearchRecord
Description

Gets the step search 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.StepSearchRecordthe step search record
ErrorsNULL_ARGUMENT stepSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(stepSearchRecordType) is false
CompliancemandatoryThis method must be implemented.