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

The search interface for governing step processor enabler searches.

MethodsearchAmongStepProcessorEnablers
Description

Execute this search among the given list of step processor enablers.

Parametersosid.id.IdListstepProcessorEnablerIdslist of step processor enablers
ErrorsNULL_ARGUMENT stepProcessorEnablerIds is null
CompliancemandatoryThis method must be implemented.
MethodorderStepProcessorEnablerResults
Description

Specify an ordering to the search results.

Parametersosid.workflow.rules.StepProcessorEnablerSearchOrderstepProcessorEnablerSearchOrderstep processor enabler search order
ErrorsNULL_ARGUMENT stepProcessorEnablerSearchOrder is null
UNSUPPORTED stepProcessorEnablerSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetStepProcessorEnablerSearchRecord
Description

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

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