Interface WorkflowEventSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface WorkflowEventSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
WorkflowEventQueryInspector	getWorkflowEventQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
WorkflowEventList	getWorkflowEvents()	Gets the workflow event list resulting from a search.
WorkflowEventSearchResultsRecord	getWorkflowEventSearchResultsRecord(Type workflowEventSearchRecordType)	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.

Methods inherited from interface Browsable

getProperties, getPropertiesByRecordType

Modifier and Type	Method	Description
PropertyList	getProperties()	Gets a list of properties.
PropertyList	getPropertiesByRecordType(Type recordType)	Gets a list of properties corresponding to the specified record type.

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 OsidSearchResults

getResultSize

Modifier and Type	Method	Description
long	getResultSize()	Returns the size of a result set from a search query.

Method Details

getWorkflowEvents

WorkflowEventList getWorkflowEvents()

Gets the workflow event list resulting from a search.

Returns:

the workflow event list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getWorkflowEventQueryInspector

WorkflowEventQueryInspector getWorkflowEventQueryInspector()

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

Returns:

the workflow event query inspector

Compliance:

mandatory - This method must be implemented.

getWorkflowEventSearchResultsRecord

WorkflowEventSearchResultsRecord getWorkflowEventSearchResultsRecord(Type workflowEventSearchRecordType)
                                                              throws OperationFailedException

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.

Parameters:

workflowEventSearchRecordType - a workflow event search record type

Returns:

the workflow event search results record

Throws:

NullArgumentException - workflowEventSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(workflowEventSearchRecordTypee) is false

Compliance:

mandatory - This method must be implemented.