Interface WorkflowEventSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface WorkflowEventSearch
extends OsidSearch

The search interface for governing workflow event searches.

Method Summary

Modifier and Type	Method	Description
WorkflowEventSearchRecord	getWorkflowEventSearchRecord(Type workflowEventSearchRecordType)	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.
void	orderWorkflowEventResults(WorkflowEventSearchOrder workflowEventSearchOrder)	Specify an ordering to the search results.
void	searchAmongWorkflowEvents(IdList workflowEventIds)	Execute this search among the given list of workflow events.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidSearch

limitResultSet

Modifier and Type	Method	Description
void	limitResultSet(long start, long end)	By default, searches return all matching results.

Method Details

searchAmongWorkflowEvents

void searchAmongWorkflowEvents(IdList workflowEventIds)

Execute this search among the given list of workflow events.

Parameters:

workflowEventIds - list of workflow events

Throws:

NullArgumentException - workflowEventIds is null

Compliance:

mandatory - This method must be implemented.

orderWorkflowEventResults

void orderWorkflowEventResults(WorkflowEventSearchOrder workflowEventSearchOrder)

Specify an ordering to the search results.

Parameters:

workflowEventSearchOrder - workflow event search order

Throws:

NullArgumentException - workflowEventSearchOrder is null

UnsupportedException - workflowEventSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getWorkflowEventSearchRecord

WorkflowEventSearchRecord getWorkflowEventSearchRecord(Type workflowEventSearchRecordType)
                                                throws OperationFailedException

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.

Parameters:

workflowEventSearchRecordType - a workflow event search record type

Returns:

the workflow event search record

Throws:

NullArgumentException - workflowEventSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(workflowEventSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.