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

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

MethodgetProcesses
Description

Gets the process list resulting from a search.

Returnosid.workflow.ProcessListthe process list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetProcessQueryInspector
Description

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

Returnosid.workflow.ProcessQueryInspectorthe process query inspector
CompliancemandatoryThis method must be implemented.
MethodgetProcessSearchResultsRecord
Description

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

Parametersosid.type.TypeprocessSearchRecordTypea process search record type
Returnosid.workflow.records.ProcessSearchResultsRecordthe process search results record
ErrorsNULL_ARGUMENT processSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(processSearchRecordType) is false
CompliancemandatoryThis method must be implemented.