| Interface | osid.workflow.event.WorkflowEventSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Used By | osid.workflow.event.WorkflowEventSearchSession | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getWorkflowEvents | ||
| Description |
Gets the workflow event list resulting from a search. | ||
| Return | osid.workflow.event.WorkflowEventList | the workflow event list | |
| Errors | ILLEGAL_STATE | list already retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getWorkflowEventQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terms used in the search. | ||
| Return | osid.workflow.event.WorkflowEventQueryInspector | the workflow event query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getWorkflowEventSearchResultsRecord | ||
| Description |
Gets the workflow event search results record
corresponding to the given workflow event search record
| ||
| Parameters | osid.type.Type | workflowEventSearchRecordType | a workflow event search record type |
| Return | osid.workflow.event.records.WorkflowEventSearchResultsRecord | the workflow event search results record | |
| Errors | NULL_ARGUMENT | workflowEventSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(workflowEventSearchRecordTypee) is
false | ||
| Compliance | mandatory | This method must be implemented. | |