OSID Logo
OSID Specifications
workflow rules package
Version 3.1.0
Interfaceosid.workflow.rules.StepConstrainerSearchResults
Implementsosid.OsidSearchResults
Used Byosid.workflow.rules.StepConstrainerSearchSession
Description

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

MethodgetStepConstrainers
Description

Gets the StepConstrainerList resulting from a search.

Returnosid.workflow.rules.StepConstrainerList the step constrainer list
ErrorsILLEGAL_STATE list has already been retrieved
Compliancemandatory This method must be implemented.
MethodgetStepConstrainerQueryInspector
Description

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

Returnosid.workflow.rules.StepConstrainerQueryInspector the step constrainer query inspector
Compliancemandatory This 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.TypestepConstrainerSearchRecordType a step constrainer search record type
Returnosid.workflow.rules.records.StepConstrainerSearchResultsRecord the step constrainer search results record
ErrorsNULL_ARGUMENT stepConstrainerSearchRecordType is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure occurred
UNSUPPORTED hasRecordType(stepConstrainerSearchRecordType) is false
Compliancemandatory This method must be implemented.