OSID Logo
OSID Specifications
workflow event package
Version 3.1.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.WorkflowEventList the workflow event list
ErrorsILLEGAL_STATE list already retrieved
Compliancemandatory This method must be implemented.
MethodgetWorkflowEventQueryInspector
Description

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

Returnosid.workflow.event.WorkflowEventQueryInspector the workflow event query inspector
Compliancemandatory This 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.TypeworkflowEventSearchRecordType a workflow event search record type
Returnosid.workflow.event.records.WorkflowEventSearchResultsRecord the workflow event search results record
ErrorsNULL_ARGUMENT workflowEventSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(workflowEventSearchRecordTypee) is false
Compliancemandatory This method must be implemented.