OSID Specifications
workflow event package
Version 3.1.0
workflow event package
Version 3.1.0
| Interface | osid.workflow.event.WorkflowEventSearchOrder | ||
|---|---|---|---|
| Implements | osid.OsidObjectSearchOrder | ||
| Used By | osid.workflow.event.WorkflowEventSearchSession | ||
osid.workflow.event.WorkflowEventSmartOfficeSession | |||
| Description |
An interface for specifying the ordering of search results. | ||
| Method | orderByTimestamp | ||
| Description |
Orders the results by timestamp. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByProcess | ||
| Description |
Orders the results by process. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsProcessSearchOrder | ||
| Description |
Tests if a process search order is available. | ||
| Return | boolean | true if a process search order is available,
false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getProcessSearchOrder | ||
| Description |
Gets the process search order. | ||
| Return | osid.workflow.ProcessSearchOrder | the process search order | |
| Errors | ILLEGAL_STATE | supportsProcessSearchOrder() is false | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByWorker | ||
| Description |
Orders the results by worker. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsWorkerSearchOrder | ||
| Description |
Tests if a worker resource search order is available. | ||
| Return | boolean | true if a resource search order is available,
false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getWorkerSearchOrder | ||
| Description |
Gets the resource search order. | ||
| Return | osid.resource.ResourceSearchOrder | the resource search order | |
| Errors | ILLEGAL_STATE | supportsWorkerSearchOrder() is false | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByWorkingAgent | ||
| Description |
Orders the results by working agent. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsWorkingAgentSearchOrder | ||
| Description |
Tests if a working agent search order is available. | ||
| Return | boolean | true if an agent search order is available,
false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getWorkingAgentSearchOrder | ||
| Description |
Gets the agent search order. | ||
| Return | osid.authentication.AgentSearchOrder | the agent search order | |
| Errors | ILLEGAL_STATE | supportsWorkingAgentSearchOrder() is false | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByWork | ||
| Description |
Orders the results by work. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsWorkSearchOrder | ||
| Description |
Tests if a work search order is available. | ||
| Return | boolean | true if a work search order is available, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getWorkSearchOrder | ||
| Description |
Gets the work search order. | ||
| Return | osid.workflow.WorkSearchOrder | the work search order | |
| Errors | ILLEGAL_STATE | supportsWorkSearchOrder() is false | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByCancaled | ||
| Description |
Orders the results by the canceled flag. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByStep | ||
| Description |
Orders the results by step. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsStepSearchOrder | ||
| Description |
Tests if a step search order is available. | ||
| Return | boolean | true if a step search order is available, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getStepSearchOrder | ||
| Description |
Gets the step search order. | ||
| Return | osid.workflow.StepSearchOrder | the step search order | |
| Errors | ILLEGAL_STATE | supportsStepSearchOrder() is false | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getWorkflowEventSearchOrderRecord | ||
| Description |
Gets the workflow event search order record
corresponding to the given workflow event record
| ||
| Parameters | osid.type.Type | workflowEventRecordType | a workflow event record type |
| Return | osid.workflow.event.records.WorkflowEventSearchOrderRecord | the workflow event search order record | |
| Errors | NULL_ARGUMENT | workflowEventRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(workflowEventRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |