public class DynamicPatternParameter extends java.lang.Object implements IDynamicPattern.IDynamicPatternParameter
IDynamicPattern.IDynamicPatternParameter
interface, used to define input parameters for dynamic pattern implementations.
This class is provided as a default implementation, and can be extended to override the default behavior.
Implementations of IDynamicPattern
may specify the parameters they support by implementing IDynamicPattern.getPatternParameters()
to return a list of DynamicAssignmentParam objects.
DynamicAssignmentParam defines the parameter name, its type (String or Number), and whether the parameter is mandatory or optional.
This default implementation provides internationlization support by looking up values for the parameter label and description from the WorkflowLabels resource bundle. It is possible to provide a custom version of this bundle to add new labels. This is described in the human workflow sample workflow-110-workflowCustomizations.
The label strings should have a key of the form:
DYN_ASSIGN_PARAM_LABEL.{patternName}.{paramName}
The description strings should have a key of the form:
DYN_ASSIGN_PARAM_DESCR.{patternName}.{paramName}
For example, the keys for the parameter "TIME_PERIOD" for the dynamic assignment pattern "MOST_PRODUCTIVE" are:
IDynamicPattern.IDynamicPatternParameter.ParameterType
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASS_NAME |
static oracle.bpel.services.common.LoggingHelper |
LOGGER |
static java.lang.String |
PARAM_DESC_PREFIX
Prefix used when looking up parameter descriptions from the resource bundle.
|
static java.lang.String |
PARAM_LABEL_PREFIX
Prefix used when looking up parameter labels from the resource bundle.
|
Constructor and Description |
---|
DynamicPatternParameter(java.lang.String patternName, java.lang.String parameterName, IDynamicPattern.IDynamicPatternParameter.ParameterType type, boolean mandatory, java.lang.String defaultValue)
Constructs an instance of a DynamicAssignmentParam, which defines the metadata for a parameter used by a Dynamic Assignment Pattern implementation.
|
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getDefaultValue()
Default value for the parameter.
|
java.lang.String |
getDescription(java.util.Locale locale)
Provides a human-readable description for the parameter, by looking up the string from the WorkflowLabels resource bundle.
|
java.lang.String |
getLabel(java.util.Locale locale)
Provides a human-readable label for the parameter, by looking up the string from the WorkflowLabels resource bundle.
|
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).
|
int |
hashCode() |
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 |
toString() |
public static final java.lang.String CLASS_NAME
public static final oracle.bpel.services.common.LoggingHelper LOGGER
public static final java.lang.String PARAM_LABEL_PREFIX
public static final java.lang.String PARAM_DESC_PREFIX
public DynamicPatternParameter(java.lang.String patternName, java.lang.String parameterName, IDynamicPattern.IDynamicPatternParameter.ParameterType type, boolean mandatory, java.lang.String defaultValue)
patternName
- Name of the dynamic pattern this parameter is for.parameterName
- Name of parameter. Must be unique amongst the parameters of a specific implementation.type
- datatype of parameter (String or Number).mandatory
- is the parameter mandatory or optional.defaultValue
- optional default value for the parameter.public java.lang.String getName()
IDynamicPattern.IDynamicPatternParameter
getName
in interface IDynamicPattern.IDynamicPatternParameter
public java.lang.String getLabel(java.util.Locale locale)
Please refer to the sample workflow-110-WorkflowCustomizations for a description of how this resource bundle can be customized to add new resource strings.
The label strings should have a key of the form:
DYN_ASSIGN_PARAM_LABEL.{patternName}.{paramName}
For example, the key for the parameter "TIME_PERIOD" for the dynamic assignment pattern "MOST_PRODUCTIVE" is:
getLabel
in interface IDynamicPattern.IDynamicPatternParameter
locale
-public java.lang.String getDescription(java.util.Locale locale)
Please refer to the sample workflow-110-WorkflowCustomizations for a description of how this resource bundle can be customized to add new resource strings.
The description strings should have a key of the form:
DYN_ASSIGN_PARAM_DESCR.{patternName}.{paramName}
For example, the key for the parameter "TIME_PERIOD" for the dynamic assignment patter "MOST_PRODUCTIVE" is:
getDescription
in interface IDynamicPattern.IDynamicPatternParameter
locale
-public IDynamicPattern.IDynamicPatternParameter.ParameterType getParameterType()
IDynamicPattern.IDynamicPatternParameter
getParameterType
in interface IDynamicPattern.IDynamicPatternParameter
public boolean isMandatory()
IDynamicPattern.IDynamicPatternParameter
isMandatory
in interface IDynamicPattern.IDynamicPatternParameter
public java.lang.String getDefaultValue()
IDynamicPattern.IDynamicPatternParameter
getDefaultValue
in interface IDynamicPattern.IDynamicPatternParameter
public void setDefaultValue(java.lang.String value)
IDynamicPattern.IDynamicPatternParameter
setDefaultValue
in interface IDynamicPattern.IDynamicPatternParameter
public java.lang.String toString()
toString
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object