com.adobe.icc.dbforms.obj
Class LetterRenderOptionsSpec

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

All Implemented Interfaces:

java.io.Serializable

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

Contains options related to letter rendering.

See Also:

Serialized Form

Constructor Summary

LetterRenderOptionsSpec()
Default Constructor

LetterRenderOptionsSpec(boolean mergeDataOnServer, boolean useTestData, boolean renderInteractive, boolean saveToFile, boolean includeFragmentsUnconditionally)
Constructor with parameters.

LetterRenderOptionsSpec(boolean mergeDataOnServer, boolean useTestData, boolean renderInteractive, boolean saveToFile, boolean includeFragmentsUnconditionally, java.lang.String locale)
Constructor with parameters.

Method Summary

java.lang.String	getLocale() Returns the locale to use for letter data resolution.
java.util.Date	getPublishDate()
boolean	isIncludeAttachments()
boolean	isIncludeFragmentsUnconditionally() Returns flag indicating whether to include fragments without evauating conditions.
boolean	isMergeDataOnServer() Returns flag indicating whether data should be merged on server or not.
boolean	isRenderInteractive() Returns true if interactive PDF is required to be rendered; for non interactive PDF returns false.
boolean	isSaveToFile() Returns flag indicating whether to save PDF into temporary file or not.
boolean	isUseTestData() Returns flag indicating whether to use test data or not.
void	setIncludeAttachments(boolean includeAttachments)
void	setIncludeFragmentsUnconditionally(boolean includeFragmentsUnconditionally) Sets flag indicating whether to include fragments without evauating conditions.
void	setLocale(java.lang.String locale) Sets the locale that should be used for letter data resolution.
void	setMergeDataOnServer(boolean mergeDataOnServer) Sets flag indicating whether data should be merged on server or not.
void	setPublishDate(java.util.Date publishDate)
void	setRenderInteractive(boolean renderInteractive) Sets flag indicating whether to render interactive or non interactive PDF.
void	setSaveToFile(boolean saveToFile) Sets flag indicating whether to save PDF into temporary file or not.
void	setUseTestData(boolean useTestData) Sets flag indicating whether to use test data or not.

Methods inherited from class java.lang.Object

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

Constructor Detail

LetterRenderOptionsSpec

public LetterRenderOptionsSpec()

Default Constructor

LetterRenderOptionsSpec

public LetterRenderOptionsSpec(boolean mergeDataOnServer,
                               boolean useTestData,
                               boolean renderInteractive,
                               boolean saveToFile,
                               boolean includeFragmentsUnconditionally)

Constructor with parameters.

Parameters:

mergeDataOnServer - False if we only need to render the Letter, without merging data with it. If False, the letter is also augmented with the FormBridge library for use in an interactive filling environment. True if data needs to be merged (in which case the FormBridge library is not included).

useTestData - specify whether to use test data for rendering or not.

renderInteractive - specify whether to render an interactive or flat PDF.

saveToFile - true to have the PDF saved to a temporary file for retrieval via URL from the client; false to have the PDF bytes returned in the PDFResponseType response.

LetterRenderOptionsSpec

public LetterRenderOptionsSpec(boolean mergeDataOnServer,
                               boolean useTestData,
                               boolean renderInteractive,
                               boolean saveToFile,
                               boolean includeFragmentsUnconditionally,
                               java.lang.String locale)

Constructor with parameters.

Parameters:

mergeDataOnServer - False if we only need to render the Letter, without merging data with it. If False, the letter is also augmented with the FormBridge library for use in an interactive filling environment. True if data needs to be merged (in which case the FormBridge library is not included).

useTestData - specify whether to use test data for rendering or not.

renderInteractive - specify whether to render an interactive or flat PDF.

saveToFile - true to have the PDF saved to a temporary file for retrieval via URL from the client; false to have the PDF bytes returned in the PDFResponseType response.

locale - locale (e.g. en_US) to use while formatting data to prepare data xml for merge.

Method Detail

isMergeDataOnServer

public boolean isMergeDataOnServer()

Returns flag indicating whether data should be merged on server or not.

Returns:

flag indicating whether data should be merged on server or not.

setMergeDataOnServer

public void setMergeDataOnServer(boolean mergeDataOnServer)

Sets flag indicating whether data should be merged on server or not.

Parameters:

mergeDataOnServer - flag indicating whether data should be merged on server or not.

isUseTestData

public boolean isUseTestData()

Returns flag indicating whether to use test data or not.

Returns:

flag indicating whether to use test data or not.

setUseTestData

public void setUseTestData(boolean useTestData)

Sets flag indicating whether to use test data or not.

Parameters:

useTestData - flag indicating whether to use test data or not.

isRenderInteractive

public boolean isRenderInteractive()

Returns true if interactive PDF is required to be rendered; for non interactive PDF returns false.

Returns:

true if interactive PDF is required to be rendered; for non interactive PDF returns false.

setRenderInteractive

public void setRenderInteractive(boolean renderInteractive)

Sets flag indicating whether to render interactive or non interactive PDF.

Parameters:

renderInteractive - indicates whether to render interactive or non interactive PDF.

isSaveToFile

public boolean isSaveToFile()

Returns flag indicating whether to save PDF into temporary file or not.

Returns:

flag indicating whether to save PDF into temporary file or not.

setSaveToFile

public void setSaveToFile(boolean saveToFile)

Sets flag indicating whether to save PDF into temporary file or not.

Parameters:

saveToFile - indicates whether to save PDF into temporary file or not.

isIncludeFragmentsUnconditionally

public boolean isIncludeFragmentsUnconditionally()

Returns flag indicating whether to include fragments without evauating conditions.

Returns:

flag indicating whether to include fragments without evauating conditions.

setIncludeFragmentsUnconditionally

public void setIncludeFragmentsUnconditionally(boolean includeFragmentsUnconditionally)

Sets flag indicating whether to include fragments without evauating conditions.

Parameters:

includeFragmentsUnconditionally - indicates whether to include fragments without evauating conditions.

getLocale

public java.lang.String getLocale()

Returns the locale to use for letter data resolution.

Returns:

locale to use for letter data resolution.

setLocale

public void setLocale(java.lang.String locale)

Sets the locale that should be used for letter data resolution.

Parameters:

locale - locale to use for letter data resolution.

isIncludeAttachments

public boolean isIncludeAttachments()

setIncludeAttachments

public void setIncludeAttachments(boolean includeAttachments)

getPublishDate

public java.util.Date getPublishDate()

Returns:

the publishDate

setPublishDate

public void setPublishDate(java.util.Date publishDate)

Parameters:

publishDate - the publishDate to set