OSID Logo
OSID Specifications
workflow rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.workflow.rules.StepConstrainerSearchResults
Implementsosid.OsidSearchResults
Description

This interface provides a means to capture results of a search.

MethodgetStepConstrainers
Description

Gets the StepConstrainerList resulting from a search.

Returnosid.workflow.rules.StepConstrainerListthe step constrainer list
ErrorsILLEGAL_STATElist has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetStepConstrainerQueryInspector
Description

Gets the inspector for the query to examine the terms used in the search.

Returnosid.workflow.rules.StepConstrainerQueryInspectorthe step constrainer query inspector
CompliancemandatoryThis method must be implemented.
MethodgetStepConstrainerSearchResultsRecord
Description

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

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