|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.adobe.icc.dbforms.obj.Variable
public class Variable
POJO representation of a Variable.
Variables may be of type DataDictionary Element (DDE) or a Placeholder (ad-hoc variable), defined by the
Variable.VariableType
type
. If it is of type DDE, then the name
would be the name/path of the
Data Dictionary Element, else (if it is a Placeholder type) it would be the name given by the user.
If a Variable is marked protected, it's value cannot be edited by the user during Correspondence creation.
Nested Class Summary | |
---|---|
static class |
Variable.VariableSubType
Enum to specify the variable subType, whether its a Enum. |
static class |
Variable.VariableType
Enum to specify the variable type, whether its a DDE or just a placeholder. |
Constructor Summary | |
---|---|
Variable()
|
Method Summary | |
---|---|
DataType |
getDataType()
Get the data type of the Variable. |
String |
getId()
Get the identifier for the Variable. |
String |
getName()
Get the name for the Variable. |
Boolean |
getProtect()
Get whether the Variable is protected. |
Variable.VariableSubType |
getSubType()
Get the type (DDE/PLACEHOLDER) of the Variable. |
Variable.VariableType |
getType()
Get the type (DDE/PLACEHOLDER) of the Variable. |
Set |
getValueSet()
|
void |
setDataType(DataType dataType)
Sets the data type of the Variable. |
void |
setId(String id)
Sets the identifier for the Variable. |
void |
setName(String name)
Sets the name for the Variable. |
void |
setProtect(Boolean protect)
Sets whether the Variable is protected. |
void |
setSubType(Variable.VariableSubType subType)
Sets the type (DDE/PLACEHOLDER) of the Variable. |
void |
setType(Variable.VariableType type)
Sets the type (DDE/PLACEHOLDER) of the Variable. |
void |
setValueSet(Set valueSet)
|
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public Variable()
Method Detail |
---|
public String getId()
public void setId(String id)
id
- The identifier for the Variable.public String getName()
public void setName(String name)
name
- The name for the Variable.public Boolean getProtect()
public void setProtect(Boolean protect)
protect
- Whether the Variable is protected.public Variable.VariableType getType()
public void setType(Variable.VariableType type)
type
- The type (DDE/PLACEHOLDER) of the Variable.public Variable.VariableSubType getSubType()
public void setSubType(Variable.VariableSubType subType)
type
- The type (DDE/PLACEHOLDER) of the Variable.public Set getValueSet()
public void setValueSet(Set valueSet)
valueSet
- the set of values for an ENUM Variablepublic DataType getDataType()
DataType
public void setDataType(DataType dataType)
dataType
- The data type of the Variable.DataType
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |