com.adobe.icc.dbforms.obj
Class FieldAssignment

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

All Implemented Interfaces:

java.io.Serializable

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

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

Fields may be assigned to one of the FieldAssignment.Bind values, and would have an associated bindingReference for that binding.

See Also:

FieldAssignment.Bind, Serialized Form

Nested Class Summary

static class

FieldAssignment.Bind

Constructor Summary

FieldAssignment()

Method Summary

FieldAssignment.Bind	getBinding() Get the FieldAssignment.Binding for the assignment.
java.lang.String	getBindingReference() Get the FieldAssignment.Binding reference for the assignment.
java.lang.String	getCaption() Get the caption for the assignment.
DataModule	getDataModule() Get the DataModule assigned to the Field.
java.lang.String	getDescription() Get the description for the assignment.
Field	getField() Get the associated Field for the assignment.
java.lang.String	getFieldPath()
java.lang.String	getId() Get the unique identifier for the assignment.
int	getOrder() Get the order in which the assignment is set in the list of assignments.
java.lang.String	getToolTip() Get the tooltip string for the assignment.
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	setBinding(FieldAssignment.Bind binding) Sets the FieldAssignment.Binding for the assignment.
void	setBindingReference(java.lang.String bindingReference) Sets the FieldAssignment.Binding reference for the assignment.
void	setCaption(java.lang.String caption) Sets the caption for the assignment.
void	setDataModule(DataModule dataModule) Sets the DataModule assigned to the Field.
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	setField(Field field) Sets the associated Field for the assignment.
void	setFieldPath(java.lang.String fieldPath)
void	setId(java.lang.String id) Sets the unique identifier for the assignment.
void	setOptional(boolean optional) Sets whether the assignment is optional.
void	setOrder(int order) Sets the order in which the assignment is set in the list of assignments.
void	setToolTip(java.lang.String toolTip) Sets the tooltip string for the assignment.

Methods inherited from class java.lang.Object

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

Constructor Detail

FieldAssignment

public FieldAssignment()

Method Detail

getId

public java.lang.String getId()

Get the unique identifier for the assignment.

Returns:

The unique identifier for the assignment.

setId

public void setId(java.lang.String id)

Sets the unique identifier for the assignment.

Parameters:

id - The unique 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 string for the assignment.

Returns:

The tooltip string for the assignment.

setToolTip

public void setToolTip(java.lang.String toolTip)

Sets the tooltip string for the assignment.

Parameters:

toolTip - The tooltip string for the assignment.

getField

public Field getField()

Get the associated Field for the assignment.

Returns:

The associated Field for the assignment.

setField

public void setField(Field field)

Sets the associated Field for the assignment.

Parameters:

field - The associated Field for the assignment.

getBinding

public FieldAssignment.Bind getBinding()

Get the FieldAssignment.Binding for the assignment.

Returns:

The FieldAssignment.Binding for the assignment.

setBinding

public void setBinding(FieldAssignment.Bind binding)

Sets the FieldAssignment.Binding for the assignment.

Parameters:

binding - The FieldAssignment.Binding for the assignment.

getBindingReference

public java.lang.String getBindingReference()

Get the FieldAssignment.Binding reference for the assignment.

Bind = DDE, then bindingReference = DD element name reference
Bind = CONST, then bindingReference = constant value
Bind = DATAMODULE, then bindingReference = ID of the data module
Bind = USER, then bindingReference = default value

Returns:

The FieldAssignment.Binding reference for the assignment.

setBindingReference

public void setBindingReference(java.lang.String bindingReference)

Sets the FieldAssignment.Binding reference for the assignment.

Parameters:

bindingReference - The FieldAssignment.Binding 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.

getOrder

public int getOrder()

Get the order in which the assignment is set in the list of assignments.

Returns:

The order in which the assignment is set in the list of assignments.

setOrder

public void setOrder(int order)

Sets the order in which the assignment is set in the list of assignments.

Parameters:

order - The order in which the assignment is set in the list of assignments.

getDataModule

public DataModule getDataModule()

Get the DataModule assigned to the Field.

Returns:

The DataModule assigned to the Field.

setDataModule

public void setDataModule(DataModule dataModule)

Sets the DataModule assigned to the Field.

Parameters:

dataModule - The DataModule assigned to the Field.

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.

getFieldPath

public java.lang.String getFieldPath()

setFieldPath

public void setFieldPath(java.lang.String fieldPath)

isAutoCorrected

public boolean isAutoCorrected()

setAutoCorrected

public void setAutoCorrected(boolean autoCorrected)

Parameters:

autoCorrected - the autoCorrected to set