OSID Logo
OSID Specifications
workflow event package
Version 3.0.0
Interfaceosid.workflow.event.WorkflowEventSearchResults
Implementsosid.OsidSearchResults
Used Byosid.workflow.event.WorkflowEventSearchSession
Description

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

MethodgetWorkflowEvents
Description

Gets the workflow event list resulting from a search.

Returnosid.workflow.event.WorkflowEventListthe workflow event list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetWorkflowEventQueryInspector
Description

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

Returnosid.workflow.event.WorkflowEventQueryInspectorthe workflow event query inspector
CompliancemandatoryThis method must be implemented.
MethodgetWorkflowEventSearchResultsRecord
Description

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

Parametersosid.type.TypeworkflowEventSearchRecordTypea workflow event search record type
Returnosid.workflow.event.records.WorkflowEventSearchResultsRecordthe workflow event search results record
ErrorsNULL_ARGUMENTworkflowEventSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTEDhasRecordType(workflowEventSearchRecordTypee) is false
CompliancemandatoryThis method must be implemented.