Jira/iwf 273 Add/fix javadocs for exception thrown #265
Conversation
| import io.iworkflow.core.ClientSideException; | ||
|
|
||
| /** | ||
| * A friendly named exception to indicate that the workflow does not exist |
There was a problem hiding this comment.
@lwolczynski I want to remove the deprecated one becaue I believe no one is using it(should be the same for OSS users).
But I realized that we need this WorkflowNotExistsException as well as NoRunningWorkflowException, because in some cases either one makes sense.
For example, for signalWorkflow API, the exception is thrown because the workflow is not open, or not exists, so NoRunningWorkflowException makes sense, but not WorkflowNotExistsException.
For getDataAttribute API, the exception is only thrown when the workflow not exists, so NoRunningWorkflowException doesn't make sense.
| * If using WorkflowAlreadyStartedOptions in WorkflowOptions, the error will be ignored if ignoreAlreadyStartedError is true. | ||
| * If ignoreAlreadyStartedError is true and also requestId is set, the requestId will be used to identify the request. The error | ||
| * will only be thrown if the requestId is different from the requestId of the existing workflow. |
There was a problem hiding this comment.
cc @lwolczynski
| * @return the requestId that is used to start the child workflow from state method. | ||
| * Only applicable for state methods (waitUntil or execute) | ||
| */ | ||
| public abstract Optional<String> getChildWorkflowRequestId(); |
There was a problem hiding this comment.
cc @lwolczynski This is a helper for using the requestId feature in AlreadyStartedOption, so that it can hide some details there (see an internal link in iwf-samples)
Description
Checklist
Related Issue
Closes #<issue_number>