| Interface | osid.workflow.event.WorkflowEventSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Used By | osid.workflow.event.WorkflowEventSearchSession | ||
| Description |
The search interface for governing workflow event searches. | ||
| Method | searchAmongWorkflowEvents | ||
| Description |
Execute this search among the given list of workflow events. | ||
| Parameters | osid.id.IdList | workflowEventIds | list of workflow events |
| Errors | NULL_ARGUMENT | workflowEventIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderWorkflowEventResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.workflow.event.WorkflowEventSearchOrder | workflowEventSearchOrder | workflow event search order |
| Errors | NULL_ARGUMENT | workflowEventSearchOrder is null | |
| UNSUPPORTED | workflowEventSearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getWorkflowEventSearchRecord | ||
| Description |
Gets the workflow event search 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.WorkflowEventSearchRecord | the workflow event search record | |
| Errors | NULL_ARGUMENT | workflowEventSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(workflowEventSearchRecordType) is
false | ||
| Compliance | mandatory | This method must be implemented. | |