| Name | State | |
|---|---|---|
| Version | 1.0 (Dev) | |
| Included Services | ||
|
Provides a read-only view of states and state flow information. This service needs to be implemented by any KS service that is going to handle states |
|---|
| Method | getProcessKeys | ||
|---|---|---|---|
| Description | This method retrieves the list of process keys associated with a type of object. | ||
| Parameters | String | typeKey | Type key |
| ContextInfo | context | Context information containing the principalId and locale information about the caller of service operation | |
| Return | StringList | List of process keys | |
| Errors | DoesNotExistException | typeKey not found | |
| InvalidParameterException | invalid typeKey | ||
| MissingParameterException | missing typeKey | ||
| OperationFailedException | unable to complete request | ||
| Method | getState | ||
|---|---|---|---|
| Description | This method returns information about a state for a given process. State keys can be reused and state key along with process key uniquely identifies the state instance within a process. | ||
| Parameters | String | processKey | Key identifying the process |
| String | stateKey | Key of the state | |
| ContextInfo | context | Context information containing the principalId and locale information about the caller of service operation | |
| Return | StateInfo | Information about the state | |
| Errors | DoesNotExistException | processKey, stateKey not found | |
| InvalidParameterException | invalid processKey, stateKey | ||
| MissingParameterException | missing processKey, stateKey | ||
| OperationFailedException | unable to complete request | ||
| Method | getStatesByProcess | ||
|---|---|---|---|
| Description | This method returns a list of States that belong to a process. For e.g Clu states for clu proposal process | ||
| Parameters | String | processKey | Key identifying the process |
| ContextInfo | context | Context information containing the principalId and locale information about the caller of service operation | |
| Return | StateInfoList | List of StateInfo objects associated with the process | |
| Errors | DoesNotExistException | processKey not found | |
| InvalidParameterException | invalid processKey | ||
| MissingParameterException | missing processKey | ||
| OperationFailedException | unable to complete request | ||
| Method | getInitialValidStates | ||
|---|---|---|---|
| Description | This method returns a list of StateInfo objects that are valid initial states for a given process. Often there will be just a single initial valid state. ? if more than one does the order matter? i.e. the 1st one returned should be the default but others still allowed? |
||
| Parameters | String | processKey | Process key |
| ContextInfo | context | Context information containing the principalId and locale information about the caller of service operation | |
| Return | StateInfoList | list of states are valid for the given process | |
| Errors | DoesNotExistException | processKey not found | |
| InvalidParameterException | invalid processKey | ||
| MissingParameterException | missing processKey | ||
| OperationFailedException | unable to complete request | ||
| Method | getNextHappyState | ||
|---|---|---|---|
| Description | This method retrieves the next happy state in a process given the current state. | ||
| Parameters | String | processKey | Process key |
| String | currentStateKey | Current state key | |
| ContextInfo | context | Context information containing the principalId and locale information about the caller of service operation | |
| Return | StateInfo | Next happy state in the process | |
| Errors | DoesNotExistException | processKey or currentStateKey not found | |
| InvalidParameterException | invalid processKey or currentStateKey | ||
| MissingParameterException | missing processKey or currentStateKey | ||
| OperationFailedException | unable to complete request | ||