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

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

MethodgetProcessEnablers
Description

Gets the ProcessEnablerList resulting from a search.

Returnosid.workflow.rules.ProcessEnablerListthe process enabler list
ErrorsILLEGAL_STATElist has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetProcessEnablerQueryInspector
Description

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

Returnosid.workflow.rules.ProcessEnablerQueryInspectorthe process enabler query inspector
CompliancemandatoryThis method must be implemented.
MethodgetProcessEnablerSearchResultsRecord
Description

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

Parametersosid.type.TypeprocessEnablerSearchRecordTypea process enabler search record type
Returnosid.workflow.rules.records.ProcessEnablerSearchResultsRecordthe process enabler search results record
ErrorsNULL_ARGUMENT processEnablerSearchRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED hasRecordType(processEnablerSearchRecordType) is false
CompliancemandatoryThis method must be implemented.