com.adobe.icc.dbforms.obj
Class Letter

java.lang.Object
  com.adobe.icc.dbforms.obj.Asset
      com.adobe.icc.dbforms.obj.Letter

All Implemented Interfaces:

ILocalizable, ILocalizationResourceContainer, java.io.Serializable

public class Letter
extends Asset
implements java.io.Serializable

POJO representation of a Correspondence Letter template.
A Letter template has an associated form which indicates the Form a.k.a Layout being used for the Letter. The list if TargetAreaAssignments, FieldAssignments and VariableAssignments indicate the bindings to Target Areas, Fields and Variables respectively in the template.

See Also:

Serialized Form

Field Summary

static java.lang.String	ASSOCIATION_CUTPOINT For internal use.
static java.lang.String	FIRST_LEVEL_CUTPOINT For internal use.
static java.lang.String	HIERARCHY_CUTPOINT For internal use.
static java.lang.String	LETTER_CLASS For internal use.

Fields inherited from class com.adobe.icc.dbforms.obj.Asset

ASSET_CLASS, FIRST_LEVEL_WITH_CAT_NAMES_CUTPOINT

Constructor Summary

Letter()
default constructor

Letter(java.lang.String id, java.lang.String name, java.lang.String desc, Form form, int state, int version, java.util.Date activeStartDate, java.util.Date activeEndDate, Category ucat, Category lcat, java.lang.String testDataFileName, java.lang.String comment, java.lang.String lastChangeBy, boolean outboxEnabled)
Constructor from parameters.

Method Summary

AttachmentAssignment	getAttachmentAssignment()
java.util.Set	getDataDictionaryElementRefs() Get the list of all Data Dictionary Elements used directly in the Letter.
java.lang.String	getDataDictionaryRef() This method retrieves the first data dictionary reference from the list of DataDictionaryRef's
java.util.List	getDataDictionaryRefs() Get the DataDictionary references(names) for the Letter.
java.util.Set	getFieldAssignments() Get the FieldAssignments of the Letter.
Form	getForm() Get the Form or Layout associated with the Letter.
java.lang.String	getFormName() Get the name of the Layout/Form associated with the Letter.
java.lang.String	getPostProcess() Get the post-process (name) associated with the Letter.
java.lang.String	getServerTestDataFilePath() For internal use.
java.util.Set	getTargetAreaAssignments() Get the TargetAreaAssignments of the Letter.
byte[]	getTestdata() Get the test data (byte array) associated with the Letter.
java.lang.String	getTestDataFileName() Get the name of the test/sample data file associated with the Letter.
java.util.Set	getVariableAssignments() Get the VariableAssignments of the Letter.
void	setAttachmentAssignment(AttachmentAssignment attachmentAssignment)
void	setDataDictionaryElementRefs(java.util.Set dataDictionaryElementRefs) Set the list of all Data Dictionary Elements used in the Letter.
void	setDataDictionaryRef(java.lang.String dataDictionary) This method sets the data dictionary reference at the first index in DataDictionaryRef list
void	setDataDictionaryRefs(java.util.List dataDictionaryRefs) Sets the DataDictionary references(names) for the Letter.
void	setFieldAssignments(java.util.Set fieldAssignmentList) Sets the FieldAssignments of the Letter.
void	setForm(Form form) Sets the Form or Layout associated with the Letter.
void	setPostProcess(java.lang.String postProcess) Sets the post-process (name) associated with the Letter.
void	setServerTestDataFilePath(java.lang.String serverTestDataFilePath) For internal use.
void	setTargetAreaAssignments(java.util.Set targetAssignmentList) Sets the TargetAreaAssignments of the Letter.
void	setTestdata(byte[] testdata) Sets the test data (byte array) associated with the Letter.
void	setTestDataFileName(java.lang.String testDataFileName) Sets the name of the test/sample data file associated with the Letter.
void	setVariableAssignments(java.util.Set variableAssignmentList) Sets the VariableAssignments of the Letter.

Methods inherited from class com.adobe.icc.dbforms.obj.Asset

getActiveEndDate, getActiveStartDate, getComment, getCrxVersion, getDesc, getExtendedProperties, getId, getLastChangeBy, getLastPublishDate, getLastUpdateDate, getLcat, getLocalizationPrefix, getLocalizationResourceInfoList, getName, getState, getUcat, getUpdatedBy, getVersion, setActiveEndDate, setActiveStartDate, setComment, setCrxVersion, setDesc, setExtendedProperties, setId, setLastChangeBy, setLastPublishDate, setLastUpdateDate, setLcat, setLocalizationPrefix, setLocalizationResourceInfoList, setName, setState, setUcat, setUpdatedBy, setVersion

Methods inherited from class java.lang.Object

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

Field Detail

LETTER_CLASS

public static final java.lang.String LETTER_CLASS

For internal use.

ASSOCIATION_CUTPOINT

public static final java.lang.String ASSOCIATION_CUTPOINT

For internal use.

HIERARCHY_CUTPOINT

public static final java.lang.String HIERARCHY_CUTPOINT

For internal use.

FIRST_LEVEL_CUTPOINT

public static final java.lang.String FIRST_LEVEL_CUTPOINT

For internal use.

Constructor Detail

Letter

public Letter()

default constructor

Letter

public Letter(java.lang.String id,
              java.lang.String name,
              java.lang.String desc,
              Form form,
              int state,
              int version,
              java.util.Date activeStartDate,
              java.util.Date activeEndDate,
              Category ucat,
              Category lcat,
              java.lang.String testDataFileName,
              java.lang.String comment,
              java.lang.String lastChangeBy,
              boolean outboxEnabled)

Constructor from parameters.

Parameters:

id - unique identifier of the Letter.

name - name of the Letter.

desc - description of the Letter.

form - Layout of the Letter.

state - state of the Letter.

version - version of the Letter.

start - activation start date of the Letter.

end - actiavtion end date of the Letter.

ucat - Category of the Letter.

lcat - Subcategory of the Letter.

testDataFileName - filename of associated test/sample data of the Letter.

comment - comment for the Letter.

lastChange - user creating the Letter

outboxEnabled - This property is not used anymore.

Method Detail

getFormName

public java.lang.String getFormName()

Get the name of the Layout/Form associated with the Letter.

Returns:

The name of the Layout/Form associated with the Letter.

getTestDataFileName

public java.lang.String getTestDataFileName()

Get the name of the test/sample data file associated with the Letter.

Returns:

the name of the test/sample data file associated with the Letter.

setTestDataFileName

public void setTestDataFileName(java.lang.String testDataFileName)

Sets the name of the test/sample data file associated with the Letter.

Parameters:

testDataFileName - The name of the test/sample data file associated with the Letter.

getTestdata

public byte[] getTestdata()

Get the test data (byte array) associated with the Letter.

Returns:

The test data (byte array) associated with the Letter.

setTestdata

public void setTestdata(byte[] testdata)

Sets the test data (byte array) associated with the Letter.

Parameters:

testdata - The test data (byte array) associated with the Letter.

getDataDictionaryRef

public java.lang.String getDataDictionaryRef()

This method retrieves the first data dictionary reference from the list of DataDictionaryRef's

Returns:

the dataDictionaryRef

setDataDictionaryRef

public void setDataDictionaryRef(java.lang.String dataDictionary)

This method sets the data dictionary reference at the first index in DataDictionaryRef list

Parameters:

dataDictionary - the dataDictionary to set

getForm

public Form getForm()

Get the Form or Layout associated with the Letter.

Returns:

The Form or Layout associated with the Letter.

setForm

public void setForm(Form form)

Sets the Form or Layout associated with the Letter.

Parameters:

form - The Form or Layout associated with the Letter.

getTargetAreaAssignments

public java.util.Set getTargetAreaAssignments()

Get the TargetAreaAssignments of the Letter.

Returns:

The TargetAreaAssignments of the Letter.

setTargetAreaAssignments

public void setTargetAreaAssignments(java.util.Set targetAssignmentList)

Sets the TargetAreaAssignments of the Letter.

Parameters:

targetAssignmentList - The TargetAreaAssignments of the Letter.

getFieldAssignments

public java.util.Set getFieldAssignments()

Get the FieldAssignments of the Letter.

Returns:

The FieldAssignments of the Letter.

setFieldAssignments

public void setFieldAssignments(java.util.Set fieldAssignmentList)

Sets the FieldAssignments of the Letter.

Parameters:

fieldAssignmentList - The FieldAssignments of the Letter.

getVariableAssignments

public java.util.Set getVariableAssignments()

Get the VariableAssignments of the Letter.

Returns:

The VariableAssignments of the Letter.

setVariableAssignments

public void setVariableAssignments(java.util.Set variableAssignmentList)

Sets the VariableAssignments of the Letter.

Parameters:

variableAssignmentList - The VariableAssignments of the Letter.

getPostProcess

public java.lang.String getPostProcess()

Get the post-process (name) associated with the Letter. This is essentially a service that would be invoked when a Letter is Submitted.

Returns:

the postProcess

setPostProcess

public void setPostProcess(java.lang.String postProcess)

Sets the post-process (name) associated with the Letter.

Parameters:

postProcess - The post-process (name) associated with the Letter.

getServerTestDataFilePath

public java.lang.String getServerTestDataFilePath()

For internal use.

setServerTestDataFilePath

public void setServerTestDataFilePath(java.lang.String serverTestDataFilePath)

For internal use.

getDataDictionaryRefs

public java.util.List getDataDictionaryRefs()

Get the DataDictionary references(names) for the Letter.

Returns:

The DataDictionary references(names) for the Letter.

setDataDictionaryRefs

public void setDataDictionaryRefs(java.util.List dataDictionaryRefs)

Sets the DataDictionary references(names) for the Letter.

Parameters:

dataDictionaryRefs - The DataDictionary references(names) for the Letter.

getDataDictionaryElementRefs

public java.util.Set getDataDictionaryElementRefs()

Get the list of all Data Dictionary Elements used directly in the Letter. This does not include the DDEs that may be within any content used in the Letter.

Returns:

the list of all Data Dictionary Elements used in the Letter.

setDataDictionaryElementRefs

public void setDataDictionaryElementRefs(java.util.Set dataDictionaryElementRefs)

Set the list of all Data Dictionary Elements used in the Letter.

Parameters:

dataDictionaryElementRefs - list of all Data Dictionary Elements used in the Letter.

getAttachmentAssignment

public AttachmentAssignment getAttachmentAssignment()

setAttachmentAssignment

public void setAttachmentAssignment(AttachmentAssignment attachmentAssignment)