OSID Specifications
workflow package
Version 3.1.0
workflow package
Version 3.1.0
| Interface | osid.workflow.StepSearchOrder | ||
|---|---|---|---|
| Implements | osid.OsidRuleSearchOrder | ||
osid.OsidSubjugateableSearchOrder | |||
| Used By | osid.workflow.ProcessSearchOrder | ||
osid.workflow.StepSearchSession | |||
osid.workflow.StepSmartOfficeSession | |||
osid.workflow.event.WorkflowEventSearchOrder | |||
| Description |
An interface for specifying the ordering of search results. | ||
| 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 | orderByInitial | ||
| Description |
Orders the results by initial steps. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByTerminal | ||
| Description |
Orders the results by terminal steps. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByNextState | ||
| Description |
Orders the results by next state. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsNextStateSearchOrder | ||
| Description |
Tests if a next state search order is available. | ||
| Return | boolean | true if a state search order is available, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getNextStateSearchOrder | ||
| Description |
Gets the next state search order. | ||
| Return | osid.process.StateSearchOrder | the state search order | |
| Errors | ILLEGAL_STATE | supportsNextStateSearchOrder() is false | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getStepSearchOrderRecord | ||
| Description |
Gets the step search order record corresponding to the
given step record | ||
| Parameters | osid.type.Type | stepRecordType | a step record type |
| Return | osid.workflow.records.StepSearchOrderRecord | the step search order record | |
| Errors | NULL_ARGUMENT | stepRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(stepRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |