com.adobe.icc.dbforms.obj
Class VariableAssignment

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

All Implemented Interfaces:

java.io.Serializable

public class VariableAssignment
extends java.lang.Object
implements java.io.Serializable

POJO representation for a Variable's assignment in a Letter template.

Variables may be assigned to one of the VariableAssignment.Source values, and would have an associated sourceReference for that binding.

See Also:

FieldAssignment.Bind, Serialized Form

Nested Class Summary

static class

VariableAssignment.Source Enum to specify source of variable assignment.

Constructor Summary

VariableAssignment()

Method Summary

java.lang.String	getCaption() Get the caption for the assignment.
DataModule	getDataModule() Get the DataModule assigned to the Variable.
java.lang.String	getDescription() Get the description for the assignment.
java.lang.String	getId() Get the identifier for the assignment.
VariableAssignment.Source	getSource() Get the source for the assignment.
java.lang.String	getSourceContainerLayoutAssignment() Get the source container layout reference for the assignment.
java.lang.String	getSourceReference() Get the source reference for the assignment.
java.lang.String	getToolTip() Get the tooltip for the assignment.
Variable	getVariable() Get the Variable associated with the assignment.
java.lang.String	getVariableId()
java.lang.String	getVariableName()
boolean	isAutoCorrected()
boolean	isEditable() Get whether the assignment is editable.
boolean	isEquivalent() Returns whether the assignment is equivalent to the DDE.
boolean	isOptional() Get whether the assignment is optional.
void	setAutoCorrected(boolean autoCorrected)
void	setCaption(java.lang.String caption) Sets the caption for the assignment.
void	setDataModule(DataModule dataModule) Sets the DataModule assigned to the Variable.
void	setDescription(java.lang.String description) Sets the description for the assignment.
void	setEditable(boolean editable) Sets whether the assignment is editable.
void	setEquivalent(boolean equivalent) Sets whether the assignment is equivalent to the DDE.
void	setId(java.lang.String id) Sets the identifier for the assignment.
void	setOptional(boolean optional) Sets whether the assignment is optional.
void	setSource(VariableAssignment.Source source) Sets the source for the assignment.
void	setSourceContainerLayoutAssignment(java.lang.String sourceContainerLayoutAssignment) Sets the source container layout for the assignment.
void	setSourceReference(java.lang.String sourceReference) Sets the source reference for the assignment.
void	setToolTip(java.lang.String toolTip) Sets the tooltip for the assignment.
void	setVariable(Variable variable) Sets the Variable associated with the assignment.
void	setVariableId(java.lang.String variableId)
void	setVariableName(java.lang.String _variableName)

Methods inherited from class java.lang.Object

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

Constructor Detail

VariableAssignment

public VariableAssignment()

Method Detail

getId

public java.lang.String getId()

Get the identifier for the assignment.

Returns:

The identifier for the assignment.

setId

public void setId(java.lang.String id)

Sets the identifier for the assignment.

Parameters:

id - The identifier for the assignment.

getDescription

public java.lang.String getDescription()

Get the description for the assignment.

Returns:

The description for the assignment.

setDescription

public void setDescription(java.lang.String description)

Sets the description for the assignment.

Parameters:

description - The description for the assignment.

getCaption

public java.lang.String getCaption()

Get the caption for the assignment.

Returns:

The caption for the assignment.

setCaption

public void setCaption(java.lang.String caption)

Sets the caption for the assignment.

Parameters:

caption - The caption for the assignment.

getToolTip

public java.lang.String getToolTip()

Get the tooltip for the assignment.

Returns:

The tooltip for the assignment.

setToolTip

public void setToolTip(java.lang.String toolTip)

Sets the tooltip for the assignment.

Parameters:

toolTip - The tooltip for the assignment.

getVariable

public Variable getVariable()

Get the Variable associated with the assignment.

Returns:

The Variable associated with the assignment.

setVariable

public void setVariable(Variable variable)

Sets the Variable associated with the assignment.

Parameters:

variable - The Variable associated with the assignment.

getSource

public VariableAssignment.Source getSource()

Get the source for the assignment.

Source = DDE, then SourceRef = DD element name reference
Source = CONST, then SourceRef = static value
Source = DATAMODULE, then SourceRef = ID of the data module
Source = USER, then SourceRef = none (blank)
Source = SYSTEM, then SourceRef = ?
Source = CALCULATION, then SourceRef = ID of Calculated Variable
Source = VARIABLE, then SourceRef = Name of the Source Variable
Source = FIELD, then SourceRef = ID of the FieldAssignment

Returns:

The source for the assignment.

setSource

public void setSource(VariableAssignment.Source source)

Sets the source for the assignment.

Parameters:

source - The source for the assignment.

getSourceReference

public java.lang.String getSourceReference()

Get the source reference for the assignment.

Returns:

The source reference for the assignment.

setSourceReference

public void setSourceReference(java.lang.String sourceReference)

Sets the source reference for the assignment.

Parameters:

sourceReference - The source reference for the assignment.

getSourceContainerLayoutAssignment

public java.lang.String getSourceContainerLayoutAssignment()

Get the source container layout reference for the assignment.

Returns:

The source container layout reference for the assignment.

setSourceContainerLayoutAssignment

public void setSourceContainerLayoutAssignment(java.lang.String sourceContainerLayoutAssignment)

Sets the source container layout for the assignment.

Parameters:

sourceContainerLayoutAssignment - The source container layout reference for the assignment.

isEditable

public boolean isEditable()

Get whether the assignment is editable.

Returns:

Whether the assignment is editable.

setEditable

public void setEditable(boolean editable)

Sets whether the assignment is editable.

Parameters:

editable - Whether the assignment is editable.

isOptional

public boolean isOptional()

Get whether the assignment is optional.

Returns:

Whether the assignment is optional.

setOptional

public void setOptional(boolean optional)

Sets whether the assignment is optional.

Parameters:

optional - whether the assignment is optional.

getDataModule

public DataModule getDataModule()

Get the DataModule assigned to the Variable.

Returns:

The DataModule assigned to the Variable.

setDataModule

public void setDataModule(DataModule dataModule)

Sets the DataModule assigned to the Variable.

Parameters:

dataModule - The DataModule assigned to the Variable.

isEquivalent

public boolean isEquivalent()

Returns whether the assignment is equivalent to the DDE.

Returns:

equivalent whether the assignment is equivalent to the DDE.

setEquivalent

public void setEquivalent(boolean equivalent)

Sets whether the assignment is equivalent to the DDE.

Parameters:

equivalent - whether the assignment is equivalent to the DDE.

getVariableId

public java.lang.String getVariableId()

setVariableId

public void setVariableId(java.lang.String variableId)

getVariableName

public java.lang.String getVariableName()

setVariableName

public void setVariableName(java.lang.String _variableName)

isAutoCorrected

public boolean isAutoCorrected()

setAutoCorrected

public void setAutoCorrected(boolean autoCorrected)

Parameters:

autoCorrected - the autoCorrected to set