public static interface IDynamicPattern.IDynamicPatternParameter
IDynamicPattern Implementations may specify the parameters they support by implementing IDynamicPattern.getPatternParameters()
to return a list of IDynamicAssignmentParam objects.
IDynamicAssignmentParam implementations define the parameter name, its type (String or Number), and whether the parameter is mandatory or optional.
The dynamic assignment framework provides a standard implementation of the IDynamicAssignmentPattern interface, DynamicPatternParameter
. If implementors want to override the behavoir of the provided class, they can do so by providing their implementation.
Modifier and Type | Interface and Description |
---|---|
static class |
IDynamicPattern.IDynamicPatternParameter.ParameterType
Enumeration of the possible types of parameter that can be used for dynamic patterns.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getDefaultValue()
Default value for the parameter.
|
java.lang.String |
getDescription(java.util.Locale locale)
Human-readable description for the parameter.
|
java.lang.String |
getLabel(java.util.Locale locale)
Human-readable label for the parameter.
|
java.lang.String |
getName()
Name of this parameter - each parameter of a given pattern must have a unique name.
|
IDynamicPattern.IDynamicPatternParameter.ParameterType |
getParameterType()
Type of parameter (number or string).
|
boolean |
isMandatory()
Is the parameter mandatory or optional.
|
void |
setDefaultValue(java.lang.String value)
Method to update the default value of a parameter.
|
java.lang.String getName()
java.lang.String getLabel(java.util.Locale locale)
getName()
locale
-java.lang.String getDescription(java.util.Locale locale)
locale
-IDynamicPattern.IDynamicPatternParameter.ParameterType getParameterType()
boolean isMandatory()
java.lang.String getDefaultValue()
void setDefaultValue(java.lang.String value)
value
-