public interface IDynamicPattern
The methods common to both types of dynamic function are defined in this interface. Pattern implementations must implement one (or both) of the sub-interfaces of this interface, IDynamicAssignmentPattern
and IDynamicTaskEscalationPattern
.
Modifier and Type | Interface and Description |
---|---|
static interface |
IDynamicPattern.IDynamicPatternParameter
Interface used to define input parameters for dynamic pattern implementations.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getDescription(java.util.Locale locale)
Returns a short, human-readable description for this dynamic pattern.
|
java.lang.String |
getLabel(java.util.Locale locale)
Returns a human-readable label for this dynamic pattern.
|
java.lang.String |
getName()
Returns the name for this pattern.
|
java.util.Set<IDynamicPattern.IDynamicPatternParameter> |
getPatternParameters()
Returns a list of the input parameters accepted by calls to the dynamic assignment function.
|
void |
setInitParams(java.util.Map<java.lang.String,java.lang.String> initParams)
Sets the initialization parameters required by the function (if any) This function is called automatically by the DynamicAssignmentRegistry on registration of a new function.
|
void setInitParams(java.util.Map<java.lang.String,java.lang.String> initParams) throws DynamicPatternException
initParams
- Map of String parameter values keyed by String parameter namesDynamicAssignmentException
- if implementation of method finds invalid parametersDynamicPatternException
java.lang.String getName()
java.lang.String getLabel(java.util.Locale locale)
locale
- Locale
that can be optionally used to provide a label in the appropriate language.java.lang.String getDescription(java.util.Locale locale)
locale
- Locale
that can be optionally used to provide a description in the appropriate language.java.util.Set<IDynamicPattern.IDynamicPatternParameter> getPatternParameters()
If the function accepts no parameters, an empty Set must be returned.