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

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

MethodgetStepConstrainerEnablers
Description

Gets the StepConstrainerEnablerList resulting from a search.

Returnosid.workflow.rules.StepConstrainerEnablerListthe step constrainer enabler list
ErrorsILLEGAL_STATElist has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetStepConstrainerEnablerQueryInspector
Description

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

Returnosid.workflow.rules.StepConstrainerEnablerQueryInspectorthe step constrainer enabler query inspector
CompliancemandatoryThis method must be implemented.
MethodgetStepConstrainerEnablerSearchResultsRecord
Description

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

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