OSID Logo
OSID Specifications
workflow event package
Version 3.1.0
Interfaceosid.workflow.event.WorkflowEventSearch
Implementsosid.OsidSearch
Used Byosid.workflow.event.WorkflowEventSearchSession
Description

The search interface for governing workflow event searches.

MethodsearchAmongWorkflowEvents
Description

Execute this search among the given list of workflow events.

Parametersosid.id.IdListworkflowEventIds list of workflow events
ErrorsNULL_ARGUMENT workflowEventIds is null
Compliancemandatory This method must be implemented.
MethodorderWorkflowEventResults
Description

Specify an ordering to the search results.

Parametersosid.workflow.event.WorkflowEventSearchOrderworkflowEventSearchOrder workflow event search order
ErrorsNULL_ARGUMENT workflowEventSearchOrder is null
UNSUPPORTED workflowEventSearchOrder is not of this service
Compliancemandatory This method must be implemented.
MethodgetWorkflowEventSearchRecord
Description

Gets the workflow event search 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.WorkflowEventSearchRecord the workflow event search record
ErrorsNULL_ARGUMENT workflowEventSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(workflowEventSearchRecordType) is false
Compliancemandatory This method must be implemented.