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

The search interface for governing step processor searches.

MethodsearchAmongStepProcessors
Description

Execute this search among the given list of step processors.

Parametersosid.id.IdListofficeIdslist of step processors
ErrorsNULL_ARGUMENT officeIds is null
CompliancemandatoryThis method must be implemented.
MethodorderStepProcessorResults
Description

Specify an ordering to the search results.

Parametersosid.workflow.rules.StepProcessorSearchOrderstepProcessorSearchOrderstep processor search order
ErrorsNULL_ARGUMENT stepProcessorSearchOrder is null
UNSUPPORTED stepProcessorSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetStepProcessorSearchRecord
Description

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

Parametersosid.type.TypestepProcessorSearchRecordTypea step processor search record type
Returnosid.workflow.rules.records.StepProcessorSearchRecordthe step processor search record
ErrorsNULL_ARGUMENT stepProcessorSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(stepProcessorSearchRecordType) is false
CompliancemandatoryThis method must be implemented.