com.adobe.icc.dbforms.obj
Class Variable

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

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

CalculatedVariable

public class Variable
extends java.lang.Object
implements java.io.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

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

java.lang.String	getDataModuleName()
DataType	getDataType() Get the data type of the Variable.
java.lang.String	getDescription() Get the description for the Variable.
java.lang.String	getId() Get the identifier for the Variable.
java.lang.String	getName() Get the name for the Variable.
java.lang.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.
java.util.List	getValueSet() Returns the list of possible values for this variable.
void	setDataModuleName(java.lang.String dataModuleId)
void	setDataType(DataType dataType) Sets the data type of the Variable.
void	setDescription(java.lang.String description) Sets the description for the Variable.
void	setId(java.lang.String id) Sets the identifier for the Variable.
void	setName(java.lang.String name) Sets the name for the Variable.
void	setProtect(java.lang.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(java.util.List valueSet) Sets possible values for this variable.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Variable

public Variable()

Method Detail

getId

public java.lang.String getId()

Get the identifier for the Variable.

Returns:

The identifier for the Variable.

setId

public void setId(java.lang.String id)

Sets the identifier for the Variable.

Parameters:

id - The identifier for the Variable.

getName

public java.lang.String getName()

Get the name for the Variable.

Returns:

The name for the Variable.

setName

public void setName(java.lang.String name)

Sets the name for the Variable.

Parameters:

name - The name for the Variable.

getDescription

public java.lang.String getDescription()

Get the description for the Variable.

Returns:

The description for the Variable.

setDescription

public void setDescription(java.lang.String description)

Sets the description for the Variable.

Parameters:

description - The description for the Variable.

getProtect

public java.lang.Boolean getProtect()

Get whether the Variable is protected.

Returns:

Whether the Variable is protected.

setProtect

public void setProtect(java.lang.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:

type - The type (DDE/PLACEHOLDER) of the Variable.

getValueSet

public java.util.List getValueSet()

Returns the list of possible values for this variable.

Returns:

the list of values for an ENUM Variable

setValueSet

public void setValueSet(java.util.List 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 java.lang.String getDataModuleName()

setDataModuleName

public void setDataModuleName(java.lang.String dataModuleId)