Variable (AEM Forms API)

java.lang.Object
- com.adobe.icc.dbforms.obj.Variable

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

CalculatedVariable
```
public class Variable
extends Object
implements Serializable
```
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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`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

Constructors
Constructor and Description

Variable()

Constructors
Constructor and Description
`Variable()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getDataModuleName()`
`DataType`	`getDataType()` Get the data type of the Variable.
`String`	`getDescription()` Get the description for 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.
`String`	`getTitle()`
`Variable.VariableType`	`getType()` Get the type (DDE/PLACEHOLDER) of the Variable.
`List<String>`	`getValueSet()` Returns the list of possible values for this variable.
`void`	`setDataModuleName(String dataModuleId)`
`void`	`setDataType(DataType dataType)` Sets the data type of the Variable.
`void`	`setDescription(String description)` Sets the description for 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`	`setTitle(String title)`
`void`	`setType(Variable.VariableType type)` Sets the type (DDE/PLACEHOLDER) of the Variable.
`void`	`setValueSet(List<String> valueSet)` Sets possible values for this variable.

- Constructor Detail
  - Variable
```
public Variable()
```
- Method Detail
  - getId
```
public String getId()
```
    Get the identifier for the Variable.
    
    Returns:
    
    The identifier for the Variable.
  - setId
```
public void setId(String id)
```
    Sets the identifier for the Variable.
    
    Parameters:
    
    id - The identifier for the Variable.
  - getName
```
public String getName()
```
    Get the name for the Variable.
    
    Returns:
    
    The name for the Variable.
  - setName
```
public void setName(String name)
```
    Sets the name for the Variable.
    
    Parameters:
    
    name - The name for the Variable.
  - getDescription
```
public String getDescription()
```
    Get the description for the Variable.
    
    Returns:
    
    The description for the Variable.
  - setDescription
```
public void setDescription(String description)
```
    Sets the description for the Variable.
    
    Parameters:
    
    description - The description for the Variable.
  - getProtect
```
public Boolean getProtect()
```
    Get whether the Variable is protected.
    
    Returns:
    
    Whether the Variable is protected.
  - setProtect
```
public void setProtect(Boolean protect)
```
    Sets whether the Variable is protected.
    
    Parameters:
    
    protect - Whether the Variable is protected.
  - getType
```
public Variable.VariableType getType()
```
    Get the type (DDE/PLACEHOLDER) of the Variable.
    
    Returns:
    
    The type (DDE/PLACEHOLDER) of the Variable.
  - setType
```
public void setType(Variable.VariableType type)
```
    Sets the type (DDE/PLACEHOLDER) of the Variable.
    
    Parameters:
    
    type - The type (DDE/PLACEHOLDER) of the Variable.
  - getSubType
```
public Variable.VariableSubType getSubType()
```
    Get the type (DDE/PLACEHOLDER) of the Variable.
    
    Returns:
    
    The type (DDE/PLACEHOLDER) of the Variable.
  - setSubType
```
public void setSubType(Variable.VariableSubType subType)
```
    Sets the type (DDE/PLACEHOLDER) of the Variable.
    
    Parameters:
    
    subType - The type (DDE/PLACEHOLDER) of the Variable.
  - getValueSet
```
public List<String> getValueSet()
```
    Returns the list of possible values for this variable.
    
    Returns:
    
    the list of values for an ENUM Variable
  - setValueSet
```
public void setValueSet(List<String> valueSet)
```
    Sets possible values for this variable.
    
    Parameters:
    
    valueSet - the list of values for an ENUM Variable
  - getDataType
```
public DataType getDataType()
```
    Get the data type of the Variable.
    
    Returns:
    
    the dataType
    
    See Also:
    
    DataType
  - setDataType
```
public void setDataType(DataType dataType)
```
    Sets the data type of the Variable.
    
    Parameters:
    
    dataType - The data type of the Variable.
    
    See Also:
    
    DataType
  - getDataModuleName
```
public String getDataModuleName()
```
  - setDataModuleName
```
public void setDataModuleName(String dataModuleId)
```
  - getTitle
```
public String getTitle()
```
  - setTitle
```
public void setTitle(String title)
```

Class Variable

Nested Class Summary

Constructor Summary

Method Summary

Constructor Detail

Variable

Method Detail

getId

setId

getName

setName

getDescription

setDescription

getProtect

setProtect

getType

setType

getSubType

setSubType

getValueSet

setValueSet

getDataType

setDataType

getDataModuleName

setDataModuleName

getTitle

setTitle