|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.adobe.icc.dbforms.obj.Asset com.adobe.icc.dbforms.obj.Letter
public final class Letter
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 TargetAreaAssignment
s, FieldAssignment
s and VariableAssignment
s indicate the bindings
to Target Areas, Fields and Variables respectively in the template.
Field Summary | |
---|---|
static String |
ASSOCIATION_CUTPOINT
|
static String |
FIRST_LEVEL_CUTPOINT
|
static String |
HIERARCHY_CUTPOINT
|
static String |
LETTER_CLASS
|
Fields inherited from class com.adobe.icc.dbforms.obj.Asset |
---|
ASSET_CLASS |
Constructor Summary | |
---|---|
Letter()
default constructor |
|
Letter(String id,
String name,
String desc,
Form form,
int state,
int version,
Date activeStartDate,
Date activeEndDate,
Category ucat,
Category lcat,
String testDataFileName,
String comment,
String lastChangeBy,
boolean outboxEnabled)
Constructor from parameters. |
Method Summary | |
---|---|
String |
getDataDictionaryRef()
This method retrieves the first data dictionary reference from the list of DataDictionaryRef's |
List |
getDataDictionaryRefs()
Get the DataDictionary references(names) for the Letter. |
Set |
getFieldAssignments()
Get the FieldAssignment s of the Letter. |
Form |
getForm()
Get the Form or Layout associated with the Letter. |
String |
getFormName()
Get the name of the Layout/Form associated with the Letter. |
String |
getPostProcess()
Get the post-process (name) associated with the Letter. |
String |
getServerTestDataFilePath()
For internal use. |
Set |
getTargetAreaAssignments()
Get the TargetAreaAssignment s of the Letter. |
byte[] |
getTestdata()
Get the test data (byte array) associated with the Letter. |
String |
getTestDataFileName()
Get the name of the test/sample data file associated with the Letter. |
Set |
getVariableAssignments()
Get the VariableAssignment s of the Letter. |
void |
setDataDictionaryRef(String dataDictionary)
This method sets the data dictionary reference at the first index in DataDictionaryRef list |
void |
setDataDictionaryRefs(List dataDictionaryRefs)
Sets the DataDictionary references(names) for the Letter. |
void |
setFieldAssignments(Set fieldAssignmentList)
Sets the FieldAssignment s of the Letter. |
void |
setForm(Form form)
Sets the Form or Layout associated with the Letter. |
void |
setPostProcess(String postProcess)
Sets the post-process (name) associated with the Letter. |
void |
setServerTestDataFilePath(String serverTestDataFilePath)
For internal use. |
void |
setTargetAreaAssignments(Set targetAssignmentList)
Sets the TargetAreaAssignment s of the Letter. |
void |
setTestdata(byte[] testdata)
Sets the test data (byte array) associated with the Letter. |
void |
setTestDataFileName(String testDataFileName)
Sets the name of the test/sample data file associated with the Letter. |
void |
setVariableAssignments(Set variableAssignmentList)
Sets the VariableAssignment s of the Letter. |
Methods inherited from class com.adobe.icc.dbforms.obj.Asset |
---|
getActiveEndDate, getActiveStartDate, getComment, getDesc, getExtendedProperties, getId, getLastChangeBy, getLastPublishDate, getLastUpdateDate, getLcat, getName, getState, getUcat, getUpdatedBy, getVersion, setActiveEndDate, setActiveStartDate, setComment, setDesc, setExtendedProperties, setId, setLastChangeBy, setLastPublishDate, setLastUpdateDate, setLcat, setName, setState, setUcat, setUpdatedBy, setVersion |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String LETTER_CLASS
public static final String ASSOCIATION_CUTPOINT
public static final String HIERARCHY_CUTPOINT
public static final String FIRST_LEVEL_CUTPOINT
Constructor Detail |
---|
public Letter()
public Letter(String id, String name, String desc, Form form, int state, int version, Date activeStartDate, Date activeEndDate, Category ucat, Category lcat, String testDataFileName, String comment, String lastChangeBy, boolean outboxEnabled)
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 LetteroutboxEnabled
- This property is not used anymore.Method Detail |
---|
public String getFormName()
public String getTestDataFileName()
public void setTestDataFileName(String testDataFileName)
testDataFileName
- The name of the test/sample data file associated with the Letter.public byte[] getTestdata()
public void setTestdata(byte[] testdata)
testdata
- The test data (byte array) associated with the Letter.public String getDataDictionaryRef()
public void setDataDictionaryRef(String dataDictionary)
dataDictionary
- the dataDictionary to setpublic Form getForm()
Form
or Layout associated with the Letter.
Form
or Layout associated with the Letter.public void setForm(Form form)
Form
or Layout associated with the Letter.
form
- The Form
or Layout associated with the Letter.public Set getTargetAreaAssignments()
TargetAreaAssignment
s of the Letter.
TargetAreaAssignment
s of the Letter.public void setTargetAreaAssignments(Set targetAssignmentList)
TargetAreaAssignment
s of the Letter.
targetAssignmentList
- The TargetAreaAssignment
s of the Letter.public Set getFieldAssignments()
FieldAssignment
s of the Letter.
FieldAssignment
s of the Letter.public void setFieldAssignments(Set fieldAssignmentList)
FieldAssignment
s of the Letter.
fieldAssignmentList
- The FieldAssignment
s of the Letter.public Set getVariableAssignments()
VariableAssignment
s of the Letter.
VariableAssignment
s of the Letter.public void setVariableAssignments(Set variableAssignmentList)
VariableAssignment
s of the Letter.
variableAssignmentList
- The VariableAssignment
s of the Letter.public String getPostProcess()
public void setPostProcess(String postProcess)
postProcess
- The post-process (name) associated with the Letter.public String getServerTestDataFilePath()
public void setServerTestDataFilePath(String serverTestDataFilePath)
public List getDataDictionaryRefs()
DataDictionary
references(names) for the Letter.
DataDictionary
references(names) for the Letter.public void setDataDictionaryRefs(List dataDictionaryRefs)
DataDictionary
references(names) for the Letter.
dataDictionaryRefs
- The DataDictionary
references(names) for the Letter.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |