OSID Logo
OSID Specifications
workflow package
Version 3.1.0
Interfaceosid.workflow.StepSearch
Implementsosid.OsidSearch
Used Byosid.workflow.StepSearchSession
Description

The search interface for governing step searches.

MethodsearchAmongSteps
Description

Execute this search among the given list of steps.

Parametersosid.id.IdListstepIds list of steps
ErrorsNULL_ARGUMENT stepIds is null
Compliancemandatory This method must be implemented.
MethodorderStepResults
Description

Specify an ordering to the search results.

Parametersosid.workflow.StepSearchOrderstepSearchOrder step search order
ErrorsNULL_ARGUMENT stepSearchOrder is null
UNSUPPORTED stepSearchOrder is not of this service
Compliancemandatory This 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.TypestepSearchRecordType a step search record type
Returnosid.workflow.records.StepSearchRecord the step search record
ErrorsNULL_ARGUMENT stepSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(stepSearchRecordType) is false
Compliancemandatory This method must be implemented.