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, Serializable

Deprecated.

Since 6.4.

public class Letter
extends Asset
implements 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

Fields

Modifier and Type	Field and Description
static String	ASSOCIATION_CUTPOINT Deprecated.
static String	FIRST_LEVEL_CUTPOINT Deprecated.
static String	HIERARCHY_CUTPOINT Deprecated.
static String	LETTER_CLASS Deprecated.
static String	TEST_DATA_ASSOCIATION_CUTPOINT Deprecated.

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

activeEndDate, activeStartDate, ASSET_CLASS, comment, crxVersion, desc, extendedProperties, FIRST_LEVEL_WITH_CAT_NAMES_CUTPOINT, folderId, id, lastChangeBy, lastPublishDate, lastPublishedBy, lastReplicationAction, lastUpdateDate, lastVersionDate, lcat, name, PROPERTY_NAME_DESCRIPTION, PROPERTY_NAME_TITLE, PROPERTY_NAME_VERSION, READY_TO_PUBLISH_CUTPOINT, state, tags, title, transientProperties, ucat, updatedBy, version

Constructor Summary

Constructors

Constructor and Description
Letter() Deprecated. default constructor
Letter(String id, String name, String desc, Form form, int state, int version, Date activeStartDate, Date activeEndDate, String testDataFileName, String comment, String lastChangeBy, boolean outboxEnabled) Deprecated. Constructor from parameters.

Method Summary

Modifier and Type	Method and Description
AttachmentAssignment	getAttachmentAssignment() Deprecated.
String	getAttachmentsFolderPath() Deprecated. Get the path to store Attachments under payload.
Set<String>	getDataDictionaryElementRefs() Deprecated. Get the list of all Data Dictionary Elements used directly in the Letter.
String	getDataDictionaryRef() Deprecated. This method retrieves the first data dictionary reference from the list of DataDictionaryRef's
List<String>	getDataDictionaryRefs() Deprecated. Get the Schema references(names) for the Letter.
String	getDataXMLPath() Deprecated. Get the path to store Data XML under payload
Set<FieldAssignment>	getFieldAssignments() Deprecated. Get the FieldAssignments of the Letter.
Form	getForm() Deprecated. Get the Form or Layout associated with the Letter.
String	getFormName() Deprecated. Get the name of the Layout/Form associated with the Letter.
String	getLayoutPath() Deprecated. Get the path to store Layout under payload.
String	getPdfPath() Deprecated. Get the path to store PDF under payload.
String	getPostProcess() Deprecated. Get the post-process (name) associated with the Letter.
String	getServerTestDataFilePath() Deprecated.
Set<TargetAreaAssignment>	getTargetAreaAssignments() Deprecated. Get the TargetAreaAssignments of the Letter.
byte[]	getTestdata() Deprecated. Get the test data (byte array) associated with the Letter.
String	getTestDataFileName() Deprecated. Get the name of the test/sample data file associated with the Letter.
Set<VariableAssignment>	getVariableAssignments() Deprecated. Get the VariableAssignments of the Letter.
boolean	isPayloadFolder() Deprecated. Get the payload structure type.
Boolean	isProcessed() Deprecated.
void	setAttachmentAssignment(AttachmentAssignment attachmentAssignment) Deprecated.
void	setAttachmentsFolderPath(String attachmentsFolderPath) Deprecated. Sets the path to store Attachments under payload.
void	setDataDictionaryElementRefs(Set<String> dataDictionaryElementRefs) Deprecated. Set the list of all Data Dictionary Elements used in the Letter.
void	setDataDictionaryRef(String dataDictionary) Deprecated. This method sets the data dictionary reference at the first index in DataDictionaryRef list
void	setDataDictionaryRefs(List<String> dataDictionaryRefs) Deprecated. Sets the Schema references(names) for the Letter.
void	setDataXMLPath(String dataXMLPath) Deprecated. Sets the path to store Data XML under payload.
void	setFieldAssignments(Set<FieldAssignment> fieldAssignmentList) Deprecated. Sets the FieldAssignments of the Letter.
void	setForm(Form form) Deprecated. Sets the Form or Layout associated with the Letter.
void	setLayoutPath(String layoutPath) Deprecated. Sets the path to store Layout under payload.
void	setPdfPath(String pdfPath) Deprecated. Sets the path to store PDF under payload.
void	setPostProcess(String postProcess) Deprecated. Sets the post-process (name) associated with the Letter.
void	setProcessed() Deprecated.
void	setServerTestDataFilePath(String serverTestDataFilePath) Deprecated.
void	setTargetAreaAssignments(Set<TargetAreaAssignment> targetAssignmentList) Deprecated. Sets the TargetAreaAssignments of the Letter.
void	setTestdata(byte[] testdata) Deprecated. Sets the test data (byte array) associated with the Letter.
void	setTestDataFileName(String testDataFileName) Deprecated. Sets the name of the test/sample data file associated with the Letter.
void	setVariableAssignments(Set<VariableAssignment> variableAssignmentList) Deprecated. Sets the VariableAssignments of the Letter.

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

equals, getActiveEndDate, getActiveStartDate, getComment, getCrxVersion, getDesc, getDisplayField, getExtendedProperties, getFolderId, getId, getLastChangeBy, getLastPublishDate, getLastPublishedBy, getLastReplicationAction, getLastUpdateDate, getLastVersionDate, getLcat, getLocalizationPrefix, getLocalizationResourceInfoList, getName, getState, getTags, getTitle, getTransientProperties, getUcat, getUpdatedBy, getVersion, hashCode, setActiveEndDate, setActiveStartDate, setComment, setCrxVersion, setDesc, setExtendedProperties, setFolderId, setId, setLastChangeBy, setLastPublishDate, setLastPublishedBy, setLastReplicationAction, setLastUpdateDate, setLastVersionDate, setLcat, setLocalizationPrefix, setLocalizationResourceInfoList, setName, setState, setTags, setTitle, setTransientProperties, setUcat, setUpdatedBy, setVersion

Field Detail

LETTER_CLASS

public static final String LETTER_CLASS

Deprecated.

TEST_DATA_ASSOCIATION_CUTPOINT

public static final String TEST_DATA_ASSOCIATION_CUTPOINT

Deprecated.

ASSOCIATION_CUTPOINT

public static final String ASSOCIATION_CUTPOINT

Deprecated.

HIERARCHY_CUTPOINT

public static final String HIERARCHY_CUTPOINT

Deprecated.

FIRST_LEVEL_CUTPOINT

public static final String FIRST_LEVEL_CUTPOINT

Deprecated.

Constructor Detail

Letter

public Letter()

Deprecated.

default constructor

Letter

public Letter(String id,
              String name,
              String desc,
              Form form,
              int state,
              int version,
              Date activeStartDate,
              Date activeEndDate,
              String testDataFileName,
              String comment,
              String lastChangeBy,
              boolean outboxEnabled)

Deprecated.

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.

activeStartDate - activation start date of the Letter.

activeEndDate - activation end date of the Letter.

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

comment - comment for the Letter.

lastChangeBy - user creating the Letter

outboxEnabled - This property is not used anymore.

Method Detail

getFormName

public String getFormName()

Deprecated.

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

Returns:

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

getTestDataFileName

public String getTestDataFileName()

Deprecated.

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(String testDataFileName)

Deprecated.

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()

Deprecated.

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)

Deprecated.

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

Parameters:

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

getDataDictionaryRef

public String getDataDictionaryRef()

Deprecated.

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

Returns:

the dataDictionaryRef

setDataDictionaryRef

public void setDataDictionaryRef(String dataDictionary)

Deprecated.

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

Parameters:

dataDictionary - the dataDictionary to set

getForm

public Form getForm()

Deprecated.

Get the Form or Layout associated with the Letter.

Returns:

The Form or Layout associated with the Letter.

setForm

public void setForm(Form form)

Deprecated.

Sets the Form or Layout associated with the Letter.

Parameters:

form - The Form or Layout associated with the Letter.

getTargetAreaAssignments

public Set<TargetAreaAssignment> getTargetAreaAssignments()

Deprecated.

Get the TargetAreaAssignments of the Letter.

Returns:

The TargetAreaAssignments of the Letter.

setTargetAreaAssignments

public void setTargetAreaAssignments(Set<TargetAreaAssignment> targetAssignmentList)

Deprecated.

Sets the TargetAreaAssignments of the Letter.

Parameters:

targetAssignmentList - The TargetAreaAssignments of the Letter.

getFieldAssignments

public Set<FieldAssignment> getFieldAssignments()

Deprecated.

Get the FieldAssignments of the Letter.

Returns:

The FieldAssignments of the Letter.

setFieldAssignments

public void setFieldAssignments(Set<FieldAssignment> fieldAssignmentList)

Deprecated.

Sets the FieldAssignments of the Letter.

Parameters:

fieldAssignmentList - The FieldAssignments of the Letter.

getVariableAssignments

public Set<VariableAssignment> getVariableAssignments()

Deprecated.

Get the VariableAssignments of the Letter.

Returns:

The VariableAssignments of the Letter.

setVariableAssignments

public void setVariableAssignments(Set<VariableAssignment> variableAssignmentList)

Deprecated.

Sets the VariableAssignments of the Letter.

Parameters:

variableAssignmentList - The VariableAssignments of the Letter.

getPostProcess

public String getPostProcess()

Deprecated.

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(String postProcess)

Deprecated.

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

Parameters:

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

getServerTestDataFilePath

public String getServerTestDataFilePath()

Deprecated.

setServerTestDataFilePath

public void setServerTestDataFilePath(String serverTestDataFilePath)

Deprecated.

getDataDictionaryRefs

public List<String> getDataDictionaryRefs()

Deprecated.

Get the Schema references(names) for the Letter.

Returns:

The Schema references(names) for the Letter.

setDataDictionaryRefs

public void setDataDictionaryRefs(List<String> dataDictionaryRefs)

Deprecated.

Sets the Schema references(names) for the Letter.

Parameters:

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

getDataDictionaryElementRefs

public Set<String> getDataDictionaryElementRefs()

Deprecated.

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(Set<String> dataDictionaryElementRefs)

Deprecated.

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()

Deprecated.

setAttachmentAssignment

public void setAttachmentAssignment(AttachmentAssignment attachmentAssignment)

Deprecated.

isProcessed

public Boolean isProcessed()

Deprecated.

setProcessed

public void setProcessed()

Deprecated.

isPayloadFolder

public boolean isPayloadFolder()

Deprecated.

Get the payload structure type. Payload is saved as folder if property is true.

Returns:

the structure type for payload

getDataXMLPath

public String getDataXMLPath()

Deprecated.

Get the path to store Data XML under payload

Returns:

the dataXMLPath

setDataXMLPath

public void setDataXMLPath(String dataXMLPath)

Deprecated.

Sets the path to store Data XML under payload.

Parameters:

dataXMLPath - The path to store Data XML under payload.

getAttachmentsFolderPath

public String getAttachmentsFolderPath()

Deprecated.

Get the path to store Attachments under payload.

Returns:

the attachmentsFolderPath

setAttachmentsFolderPath

public void setAttachmentsFolderPath(String attachmentsFolderPath)

Deprecated.

Sets the path to store Attachments under payload.

Parameters:

attachmentsFolderPath - The path to store Attachments under payload.

getPdfPath

public String getPdfPath()

Deprecated.

Get the path to store PDF under payload.

Returns:

the pdfPath

setPdfPath

public void setPdfPath(String pdfPath)

Deprecated.

Sets the path to store PDF under payload.

Parameters:

pdfPath - The path to store PDF under payload.

getLayoutPath

public String getLayoutPath()

Deprecated.

Get the path to store Layout under payload.

Returns:

the layoutPath

setLayoutPath

public void setLayoutPath(String layoutPath)

Deprecated.

Sets the path to store Layout under payload.

Parameters:

layoutPath - The path to store Layout under payload.