-
Task
-
Resolution: Won't Fix
-
L3 - Default
-
None
-
None
-
None
Given the following two methods:
- DelegateExecution#setVariable(String varName, Object varValue)
- DelegateExecution#setVariable(String varName, Object varValue, String destinationScope)
When invoked, the two methods have different behaviors regarding the Scope of the variables. [1] will set the variable to the lowest possible scope where a variable of that name is found. [2] will set the variable to the specified destinationScope, unless the destinationScope is explicitly set to null.
Then, as a user, I can read a more clear documentation about this difference in behavior in the JavaDocs, as well as the documentation:
This is the controller panel for Smart Panels app
[CAM-11706] Improve scope documentation for setting Variables
Description |
Original:
*Given* the following two methods:
# {{DelegateExecution#setVariable(String varName, Object varValue)}} # {{DelegateExecution#setVariable(String varName, Object varValue, String destinationScope)}} *When* invoked, the two methods have different behaviors regarding the Scope of the variables. [1] will set the variable to the lowest possible scope where a variable of that name is found. [2] will set the variable to the specified {{destinationScope}}, unless the {{destinationScope}} is *explicitly* set to {{null}}. *Then,* as a user, I can read about this difference in behavior. |
New:
*Given* the following two methods:
# {{DelegateExecution#setVariable(String varName, Object varValue)}} # {{DelegateExecution#setVariable(String varName, Object varValue, String destinationScope)}} *When* invoked, the two methods have different behaviors regarding the Scope of the variables. [1] will set the variable to the lowest possible scope where a variable of that name is found. [2] will set the variable to the specified {{destinationScope}}, unless the {{destinationScope}} is *explicitly* set to {{null}}. *Then,* as a user, I can read a more clear documentation about this difference in behavior. |
Mentioned Roles |
Mentioned Groups |
Description |
Original:
*Given* the following two methods:
# {{DelegateExecution#setVariable(String varName, Object varValue)}} # {{DelegateExecution#setVariable(String varName, Object varValue, String destinationScope)}} *When* invoked, the two methods have different behaviors regarding the Scope of the variables. [1] will set the variable to the lowest possible scope where a variable of that name is found. [2] will set the variable to the specified {{destinationScope}}, unless the {{destinationScope}} is *explicitly* set to {{null}}. *Then,* as a user, I can read a more clear documentation about this difference in behavior. |
New:
*Given* the following two methods:
# {{DelegateExecution#setVariable(String varName, Object varValue)}} # {{DelegateExecution#setVariable(String varName, Object varValue, String destinationScope)}} *When* invoked, the two methods have different behaviors regarding the Scope of the variables. [1] will set the variable to the lowest possible scope where a variable of that name is found. [2] will set the variable to the specified {{destinationScope}}, unless the {{destinationScope}} is *explicitly* set to {{null}}. *Then,* as a user, I can read a more clear documentation about this difference in behavior in the JavaDocs, as well as the documentation: * https://github.com/camunda/camunda-bpm-platform/blob/master/engine/src/main/java/org/camunda/bpm/engine/delegate/DelegateExecution.java#L117 * https://github.com/camunda/camunda-bpm-platform/blob/master/engine/src/main/java/org/camunda/bpm/engine/delegate/DelegateExecution.java#L117 |
Mentioned Roles |
Mentioned Groups |
Description |
Original:
*Given* the following two methods:
# {{DelegateExecution#setVariable(String varName, Object varValue)}} # {{DelegateExecution#setVariable(String varName, Object varValue, String destinationScope)}} *When* invoked, the two methods have different behaviors regarding the Scope of the variables. [1] will set the variable to the lowest possible scope where a variable of that name is found. [2] will set the variable to the specified {{destinationScope}}, unless the {{destinationScope}} is *explicitly* set to {{null}}. *Then,* as a user, I can read a more clear documentation about this difference in behavior in the JavaDocs, as well as the documentation: * https://github.com/camunda/camunda-bpm-platform/blob/master/engine/src/main/java/org/camunda/bpm/engine/delegate/DelegateExecution.java#L117 * https://github.com/camunda/camunda-bpm-platform/blob/master/engine/src/main/java/org/camunda/bpm/engine/delegate/DelegateExecution.java#L117 |
New:
*Given* the following two methods:
# {{DelegateExecution#setVariable(String varName, Object varValue)}} # {{DelegateExecution#setVariable(String varName, Object varValue, String destinationScope)}} *When* invoked, the two methods have different behaviors regarding the Scope of the variables. [1] will set the variable to the lowest possible scope where a variable of that name is found. [2] will set the variable to the specified {{destinationScope}}, unless the {{destinationScope}} is *explicitly* set to {{null}}. *Then,* as a user, I can read a more clear documentation about this difference in behavior in the JavaDocs, as well as the documentation: * https://github.com/camunda/camunda-bpm-platform/blob/master/engine/src/main/java/org/camunda/bpm/engine/delegate/VariableScope.java#L61 * https://github.com/camunda/camunda-bpm-platform/blob/master/engine/src/main/java/org/camunda/bpm/engine/delegate/DelegateExecution.java#L117 |
Mentioned Roles |
Mentioned Groups |