Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Please check if the PR fulfills these requirements
Does this PR already have an issue describing the problem?
No
What kind of change does this PR introduce?
Feature
What is the current behavior?
What is the new behavior (if this is a feature change)?
The parameters now have new optional attributes:
categoryKey
: a free-text attribute containing a business key to group together the parameters which concern a same topic;usageRestrictions
: an object indicating that the current parameter is used only when another parameters have a specific value. For instance, parameterp3
is used only whenp1
have a value in{ "value1", "value3"}
ANDp2
istrue
;unitSymbol
: a free-text attribute containing the unit of the expected values for the parameter. The most common units can be found inParameterUnit
.To ease the parameters' creation, a builder was also introduced, but the existing methods were kept.
Does this PR introduce a breaking change or deprecate an API?
If yes, please check if the following requirements are fulfilled
What changes might users need to make in their application due to this PR? (migration steps)
Parameter.getPossibleValues()
now returns anOptional<List<Object>>
instead of a nullableList<Object>
.LoadFlowProvider
implementation should implement the new method:List<String> getUnsupportedGenericParameters();
, which returns the ids of the generic parameters which are unsupported by the LoadFlow provider.Other information:
For instance, you can create parameters with the given syntaxes: