OSID Logo
OSID Specifications
workflow rules package
Version 3.0.0
Interfaceosid.workflow.rules.ProcessProcessorEnablerSearchResults
Implementsosid.OsidSearchResults
Used Byosid.workflow.rules.ProcessProcessorEnablerSearchSession
Description

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

MethodgetProcessProcessorEnablers
Description

Gets the process processor enabler list resulting from a search.

Returnosid.workflow.rules.ProcessProcessorEnablerListthe process processor enabler list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetProcessProcessorEnablerQueryInspector
Description

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

Returnosid.workflow.rules.ProcessProcessorEnablerQueryInspectorthe process processor enabler query inspector
CompliancemandatoryThis method must be implemented.
MethodgetProcessProcessorEnablerSearchResultsRecord
Description

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

Parametersosid.type.TypeprocessProcessorEnablerSearchRecordTypea process processor enabler search record type
Returnosid.workflow.rules.records.ProcessProcessorEnablerSearchResultsRecordthe process processor enabler search results record
ErrorsNULL_ARGUMENTprocessProcessorEnablerSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTEDhasRecordType(processProcessorEnablerSearchRecordType) is false
CompliancemandatoryThis method must be implemented.