Interface ConstraintEntityParameter
-
- All Superinterfaces:
Serializable
public interface ConstraintEntityParameter extends Serializable
A representation of a parameter of the entity to use for constraint evaluation. This representation may wrap one of the following:- a
JobParameter, if the constraint is being evaluated in the context of a job. - a
JobChainCallParameter, if the constraint is being evaluated in the job chain editor. - a
TableValue, if the constraint is being evaluated in the context of a table.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description StringgetDescription()Get the description of this parameter.ObjectgetInValue()Get the input value of this parameter.DateTimeZonegetInValueDate()Get the input value of this parameter if it is of type Date.BigDecimalgetInValueNumber()Get the input value of this parameter if it is of type Number.StringgetInValueString()Get the input value of this parameter if it is of type String.StringgetName()Get the name of this parameter.booleanisArray()Returns true if this parameter is an array parameter.voidsetInValue(Object newObject)Set the input value of this parameter as an object.voidsetInValueString(String newString)Set the input value of this parameter as a string.
-
-
-
Method Detail
-
getInValueString
String getInValueString()
Get the input value of this parameter if it is of type String.- Returns:
- the String value.
-
getInValueNumber
BigDecimal getInValueNumber()
Get the input value of this parameter if it is of type Number.- Returns:
- the Number value.
-
getInValueDate
DateTimeZone getInValueDate()
Get the input value of this parameter if it is of type Date.- Returns:
- the Date value.
-
getInValue
Object getInValue()
Get the input value of this parameter.- Returns:
- the value.
-
setInValue
void setInValue(Object newObject)
Set the input value of this parameter as an object.- Parameters:
newObject- the new value.
-
setInValueString
void setInValueString(String newString)
Set the input value of this parameter as a string.- Parameters:
newString- the new value.
-
getName
String getName()
Get the name of this parameter.- Returns:
- the name.
-
getDescription
String getDescription()
Get the description of this parameter. If the description is null, then the name will be returned.- Returns:
- the description.
-
isArray
boolean isArray()
Returns true if this parameter is an array parameter.- Returns:
- True if array parameter, false otherwise.
-
-