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

The search interface for governing step constrainer searches.

MethodsearchAmongStepConstrainers
Description

Execute this search among the given list of step constrainers.

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

Specify an ordering to the search results.

Parametersosid.workflow.rules.StepConstrainerSearchOrderstepConstrainerSearchOrderstep constrainer search order
ErrorsNULL_ARGUMENT stepConstrainerSearchOrder is null
UNSUPPORTED stepConstrainerSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetStepConstrainerSearchRecord
Description

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

Parametersosid.type.TypestepConstrainerSearchRecordTypea step constrainer search record type
Returnosid.workflow.rules.records.StepConstrainerSearchRecordthe step constrainer search record
ErrorsNULL_ARGUMENT stepConstrainerSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(stepConstrainerSearchRecordType) is false
CompliancemandatoryThis method must be implemented.