Interface | osid.workflow.ProcessSearchOrder | ||
---|---|---|---|
Implements | osid.OsidGovernatorSearchOrder | ||
Description |
An interface for specifying the ordering of search results. | ||
Method | orderByEnabled | ||
Description |
Orders the results by enabled. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderByInitialStep | ||
Description |
Orders the results by initial step. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsInitialStepSearchOrder | ||
Description |
Tests if an initial 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 | getInitialStepSearchOrder | ||
Description |
Gets the initial step search order. | ||
Return | osid.workflow.StepSearchOrder | the step search order | |
Errors | ILLEGAL_STATE | supportsInitialStepSearchOrder() is false | |
Compliance | mandatory | This method must be implemented. | |
Method | orderByInitialState | ||
Description |
Orders the results by initial state. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsInitialStateSearchOrder | ||
Description |
Tests if an initial 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 | getInitialStateSearchOrder | ||
Description |
Gets the initial state search order. | ||
Return | osid.process.StateSearchOrder | the state search order | |
Errors | ILLEGAL_STATE | supportsInitialStateSearchOrder() is false | |
Compliance | mandatory | This method must be implemented. | |
Method | getProcessSearchOrderRecord | ||
Description |
Gets the process search order record corresponding to
the given process record | ||
Parameters | osid.type.Type | processRecordType | a process record type |
Return | osid.workflow.records.ProcessSearchOrderRecord | the process search order record | |
Errors | NULL_ARGUMENT | processRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(processRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |