com.adobe.livecycle.output.client
Class PDFOutputOptionsSpec

java.lang.Object
  com.adobe.livecycle.output.client.PDFOutputOptionsSpec

All Implemented Interfaces:

java.io.Serializable

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

Simplifies the creation and data retrieval of a print specification XML file. A print specification contains information that is required by the Output service during each invocation request. By configuring a print specification, you can instruct the Output service to perform tasks such as sending a print stream to a network printer, or to write a print stream to a file. An object of this type is passed to the OutputClient object's generatePDFOutput method.

To see an object of this type used in a code example, see the Creating a PDF document using the Java API quick start in Programming with LiveCycle ES4.

See Also:

generatePDFOutput, Serialized Form

Constructor Summary

PDFOutputOptionsSpec()
A constructor that does not set print specification options.

PDFOutputOptionsSpec(java.lang.String serverPrintSpec, java.lang.String recordName, int recordLevel, int lookAhead, java.util.List rules, java.lang.String XCIURI, java.lang.String printerURI, java.lang.String fileURI, boolean generateManyFiles, java.lang.String metaDataSpecFile, boolean recordLevelMetaData, java.lang.String recordIdField, java.lang.String lpdURI, java.lang.String printerQueueName, java.lang.String charset, java.lang.String locale)
A constructor that sets all print specification options.

PDFOutputOptionsSpec(java.lang.String serverPrintSpec, java.lang.String recordName, int recordLevel, int lookAhead, java.util.List rules, java.lang.String XCIURI, java.lang.String printerURI, java.lang.String fileURI, boolean generateManyFiles, java.lang.String metaDataSpecFile, boolean recordLevelMetaData, java.lang.String recordIdField, java.lang.String lpdURI, java.lang.String printerQueueName, java.lang.String charset, java.lang.String locale, ResourcesInPDF useResourcesInPDF)
A constructor that sets all print specification options.

Method Summary

java.lang.String	getCharset() Gets the character set used to encode the output byte stream.
java.lang.String	getFileURI() Returns a file URI value that the Output service uses to write the output stream to a file.
java.lang.Boolean	getLazyLoading() Decides whether lazy loading is set.
java.lang.String	getLocale() Gets a locale value
int	getLookAhead() Returns the lookahead bytes used for the search rules.
java.lang.String	getLpdURI() Returns the specified Line Printer Daemon (LPD) URI when the network has a LP daemon running.
java.lang.String	getMetaDataSpecFile() Returns the metaDataSpecFile value.
java.lang.String	getPrinterQueueName() Returns the name of the printer queue that is used with the Line Printer Daemon (LPD) URI.
java.lang.String	getPrinterURI() Returns the destination for the printed output.
java.lang.String	getRecordIdField() Returns the identifier value for the batch record by using the Xpath value that is located in the input XML data.
int	getRecordLevel() Returns the element level (located within the input data file) that contains data records where the root is level 1.
java.lang.String	getRecordName() Returns the element name (located within the input data file) that identifies the beginning of a batch of records.
java.util.List	getRules() Returns a list of search rules that scan the input data file for a pattern and associates the data with a specific form design.
java.lang.String	getServerPrintSpec() Returns the print specification name.
ResourcesInPDF	getUseResourcesInPDF() This is used for determining the types of resources which need to be retrieved from the pdf form for re-rendering
java.lang.String	getXCIURI() Returns the XCI file to use when generating a document output stream.
boolean	isEnableViewerPreferences() This returns the value that specifies whether the PDF Print Options specified during template design would be used or not.
boolean	isGenerateManyFiles() Returns whether the Output service creates a single or multiple output streams.
boolean	isRecordLevelMetaData() Returns true if the recordLevelMetaData value is set.
boolean	isRetainPDFFormState() This returns the value which specifies whether the form state is retained or not during the operation.
void	setCharset(java.lang.String charset) Sets the character set used to encode the output byte stream.
void	setEnableViewerPreferences(boolean enableViewerPreferences) This sets the value that specifies whether the PDF Print Options specified during template design would be used or not.
void	setFileURI(java.lang.String fileURI) Sets a file URI value that the Output service uses to write the output stream to a file.
void	setGenerateManyFiles(boolean generateManyFiles) Specifies whether the Output service creates a single or multiple output streams.
void	setLazyLoading(java.lang.Boolean lazyLoading) Sets the lazy loading parameter.
void	setLocale(java.lang.String locale) Sets the locale value
void	setLookAhead(int lookAhead)
void	setLpdURI(java.lang.String lpdURI) Sets the specified Line Printer Daemon (LPD) URI when the network has a LP daemon running.
void	setMetaDataSpecFile(java.lang.String metaDataSpecFile) Sets the metaDataSpecFile value.
void	setPrinterQueueName(java.lang.String printerQueueName) Sets the name of the printer queue that is used with the Line Printer Daemon (LPD) URI.
void	setPrinterURI(java.lang.String printerURI) Sets the destination for the print output.
void	setRecordIdField(java.lang.String recordIdField) Sets the identifier value for the batch record.
void	setRecordLevel(int recordLevel) Sets the element level (located within the input data file) that contains data records where the root is level 1.
void	setRecordLevelMetaData(boolean recordLevelMetaData) Sets the recordLevelMetaData value.
void	setRecordName(java.lang.String recordName) Sets the element name (located within the input data file) that identifies the beginning of a record.
void	setRetainPDFFormState(boolean retainPDFFormState) This sets the value which specifies whether the form state is retained or not during the operation.
void	setRules(java.util.List rules) Sets a list of search rules that scan the input data file for a pattern and associates the data with a specific form design.
void	setServerPrintSpec(java.lang.String serverPrintSpec) Sets the print specification name.
void	setUseResourcesInPDF(ResourcesInPDF useResourcesInPDF) This is used for setting the types of resources which need to be retrieved from the pdf form for re-rendering
void	setXCIURI(java.lang.String XCIURI) Sets the XCI file to use when generating a document output stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

PDFOutputOptionsSpec

public PDFOutputOptionsSpec()

A constructor that does not set print specification options.

PDFOutputOptionsSpec

public PDFOutputOptionsSpec(java.lang.String serverPrintSpec,
                            java.lang.String recordName,
                            int recordLevel,
                            int lookAhead,
                            java.util.List rules,
                            java.lang.String XCIURI,
                            java.lang.String printerURI,
                            java.lang.String fileURI,
                            boolean generateManyFiles,
                            java.lang.String metaDataSpecFile,
                            boolean recordLevelMetaData,
                            java.lang.String recordIdField,
                            java.lang.String lpdURI,
                            java.lang.String printerQueueName,
                            java.lang.String charset,
                            java.lang.String locale,
                            ResourcesInPDF useResourcesInPDF)

A constructor that sets all print specification options.

PDFOutputOptionsSpec

public PDFOutputOptionsSpec(java.lang.String serverPrintSpec,
                            java.lang.String recordName,
                            int recordLevel,
                            int lookAhead,
                            java.util.List rules,
                            java.lang.String XCIURI,
                            java.lang.String printerURI,
                            java.lang.String fileURI,
                            boolean generateManyFiles,
                            java.lang.String metaDataSpecFile,
                            boolean recordLevelMetaData,
                            java.lang.String recordIdField,
                            java.lang.String lpdURI,
                            java.lang.String printerQueueName,
                            java.lang.String charset,
                            java.lang.String locale)

A constructor that sets all print specification options.

Method Detail

getUseResourcesInPDF

public ResourcesInPDF getUseResourcesInPDF()

This is used for determining the types of resources which need to be retrieved from the pdf form for re-rendering

Returns:

PDFResourcesEnum

setUseResourcesInPDF

public void setUseResourcesInPDF(ResourcesInPDF useResourcesInPDF)

This is used for setting the types of resources which need to be retrieved from the pdf form for re-rendering

isRetainPDFFormState

public boolean isRetainPDFFormState()

This returns the value which specifies whether the form state is retained or not during the operation. This option is applicable only for XFA PDF Forms when no input data is sent.

Returns:

A boolean value

setRetainPDFFormState

public void setRetainPDFFormState(boolean retainPDFFormState)

This sets the value which specifies whether the form state is retained or not during the operation. This option is applicable only for XFA PDF Forms when no input data is sent.

Parameters:

supportFormState -

isEnableViewerPreferences

public boolean isEnableViewerPreferences()

This returns the value that specifies whether the PDF Print Options specified during template design would be used or not. The options supplied during form design will override the default XCI options. But these options cannot override the PDF Print Options specified in customer user specified XCI.

Returns:

A boolean value

setEnableViewerPreferences

public void setEnableViewerPreferences(boolean enableViewerPreferences)

This sets the value that specifies whether the PDF Print Options specified during template design would be used or not. The options supplied during form design will override the default XCI options. But these options cannot override the PDF Print Options specified in customer user specified XCI.

Parameters:

enableViewerPreferences -

getPrinterURI

public java.lang.String getPrinterURI()

Returns the destination for the printed output. You can assign the name of a network printer resulting in the Output service sending the print stream to a printer. For example, \\PrintServer\Print1.

Returns:

A string value that specifies a destination for the printed output.

setPrinterURI

public void setPrinterURI(java.lang.String printerURI)

Sets the destination for the print output. You can assign the name of a network printer resulting in the Output service sending the print stream to a printer. For example, \\PrintServer\Print1.

Parameters:

printerURI - A string value that specifies a destination for the print output.

getFileURI

public java.lang.String getFileURI()

Returns a file URI value that the Output service uses to write the output stream to a file. For example, c:/save/output.pdf.

Returns:

A string value that represents the file URI location.

setFileURI

public void setFileURI(java.lang.String fileURI)

Sets a file URI value that the Output service uses to write the output stream to a file. For example, assume that you pass the following value to this method c:/save/output.pdf. In this situation, the Output service writes the output stream to a file named output.pdf that is located on the server at c:/save.

Parameters:

fileURI - A string value that represents the file URI location.

isGenerateManyFiles

public boolean isGenerateManyFiles()

Returns whether the Output service creates a single or multiple output streams.

Returns:

A boolean value that specifies whether the Output service creates a single output stream or multiple output streams.

setGenerateManyFiles

public void setGenerateManyFiles(boolean generateManyFiles)

Specifies whether the Output service creates a single or multiple output streams.

To see this method used in a code example, see the Creating multiple PDF files using the Java API quick start in Programming with LiveCycle ES4.

Parameters:

generateManyFiles - A boolean value that specifies whether the Output service creates a single output stream or multiple output streams.

getServerPrintSpec

public java.lang.String getServerPrintSpec()

Returns the print specification name. A print specification contains information that is required by the Output service during each invocation request. By configuring a print specification, you can instruct the Output service to send an output stream to a network printer, an email recipient as a file attachment, or to write the output stream to a file, such as a PostScript file.

Returns:

A string value that represents the print specification name.

setServerPrintSpec

public void setServerPrintSpec(java.lang.String serverPrintSpec)

Sets the print specification name. A print specification contains information that is required by the Output service during each invocation request. By configuring a print specification, you can instruct the Output service to send an output stream to a network printer, an email recipient as a file attachment, or to write the output stream to a file, such as a PostScript file.

Parameters:

serverPrintSpec - A string value that represents the print specification name.

getRecordName

public java.lang.String getRecordName()

Returns the element name (located within the input data file) that identifies the beginning of a batch of records. This value cannot be used with the recordLevel value. Returns A string value that represents the element name that identifies the beginning of a batch of records.

setRecordName

public void setRecordName(java.lang.String recordName)

Sets the element name (located within the input data file) that identifies the beginning of a record. By setting this value, you are specifying that the input data contains record batches. This value cannot be used with the recordLevel value.

To see this method used in a code example, see the Creating multiple PDF files using the Java API quick start in Programming with LiveCycle ES4.

Parameters:

recordName - A string value that represents the element name that identifies the beginning of a batch of records.

getRecordLevel

public int getRecordLevel()

Returns the element level (located within the input data file) that contains data records where the root is level 1. This value cannot be used with the recordName value. Returns The batch record level.

setRecordLevel

public void setRecordLevel(int recordLevel)

Sets the element level (located within the input data file) that contains data records where the root is level 1. This value cannot be used with the recordName value.

Parameters:

recordLevel - The batch record level.

getXCIURI

public java.lang.String getXCIURI()

Returns the XCI file to use when generating a document output stream.

Returns:

A string value that specifies the path of XCI file to use.

setXCIURI

public void setXCIURI(java.lang.String XCIURI)

Sets the XCI file to use when generating a document output stream. An XCI file is a configuration file that the Output service uses. By default, the Output service uses a XCI file named pa.xci.

Parameters:

XCIURI - A string value that specifies the XCI file to use.

getLookAhead

public int getLookAhead()

Returns the lookahead bytes used for the search rules. The lookahead value is an integer indicating the number of bytes to use from the beginning of the input data file to scan for the pattern strings.

Returns:

The number of bytes to use from the beginning of the input data file to scan for the pattern strings.

setLookAhead

public void setLookAhead(int lookAhead)

getRules

public java.util.List getRules()

Returns a list of search rules that scan the input data file for a pattern and associates the data with a specific form design.

Returns:

A list of search rules.

setRules

public void setRules(java.util.List rules)

Sets a list of search rules that scan the input data file for a pattern and associates the data with a specific form design.

To see this method used in a code example, see the Creating search rules using the Java API quick start in Programming with LiveCycle ES4.

Parameters:

rules - A list of search rules.

getMetaDataSpecFile

public java.lang.String getMetaDataSpecFile()

Returns the metaDataSpecFile value. This value is used to generate metadata.

Returns:

A string value that represents the metaDataSpecFile value.

setMetaDataSpecFile

public void setMetaDataSpecFile(java.lang.String metaDataSpecFile)

Sets the metaDataSpecFile value. This value is used to generate metadata.

Parameters:

metaDataSpecFile - A string value that represents the metaDataSpecFile value.

isRecordLevelMetaData

public boolean isRecordLevelMetaData()

Returns true if the recordLevelMetaData value is set.

Returns:

A Boolean value that specifies whether the recordLevelMetaData value is set.

setRecordLevelMetaData

public void setRecordLevelMetaData(boolean recordLevelMetaData)

Sets the recordLevelMetaData value. This value is used to generate metadata.

Parameters:

recordLevelMetaData - A Boolean value that specifies whether the recordLevelMetaData value is set.

getRecordIdField

public java.lang.String getRecordIdField()

Returns the identifier value for the batch record by using the Xpath value that is located in the input XML data.

Returns:

A string value that represents the identifier value for the batch record.

setRecordIdField

public void setRecordIdField(java.lang.String recordIdField)

Sets the identifier value for the batch record.

Parameters:

recordIdField - A string value that represents the identifier value for the batch record.

getLpdURI

public java.lang.String getLpdURI()

Returns the specified Line Printer Daemon (LPD) URI when the network has a LP daemon running.

Returns:

A string value that represents the LPD URI.

See Also:

lprPrint

setLpdURI

public void setLpdURI(java.lang.String lpdURI)

Sets the specified Line Printer Daemon (LPD) URI when the network has a LP daemon running.

Parameters:

lpdURI - A string value that represents the LPD URI.

See Also:

lprPrint

getPrinterQueueName

public java.lang.String getPrinterQueueName()

Returns the name of the printer queue that is used with the Line Printer Daemon (LPD) URI.

Returns:

A string value that represents the name of the printer queue.

See Also:

lprPrint

setPrinterQueueName

public void setPrinterQueueName(java.lang.String printerQueueName)

Sets the name of the printer queue that is used with the Line Printer Daemon (LPD) URI.

Parameters:

printerQueueName - A string value that represents the name of the printer queue.

See Also:

lprPrint

getCharset

public java.lang.String getCharset()

Gets the character set used to encode the output byte stream.

Returns:

The character set used to encode the output byte stream.

See Also:

setCharset()

setLazyLoading

public void setLazyLoading(java.lang.Boolean lazyLoading)

Sets the lazy loading parameter. For information about lazy loading, see the Output section in the LiveCycle ES2 Service guide.

Parameters:

lazyloading - true if the lazy loading is set, false otherwise.

getLazyLoading

public java.lang.Boolean getLazyLoading()

Decides whether lazy loading is set. For information about lazy loading, see the Output section in the LiveCycle ES2 Service guide.

Returns:

A boolean that specified whether lazy loading is set or not.

setCharset

public void setCharset(java.lang.String charset)

Sets the character set used to encode the output byte stream.

Parameters:

charset - The character set used to encode the output byte stream.

getLocale

public java.lang.String getLocale()

Gets a locale value

Returns:

A string value that represents the locale value.

See Also:

setLocale()

setLocale

public void setLocale(java.lang.String locale)

Sets the locale value

Parameters:

locale - The locale value to set. The following table lists valid values:

Locale	Description
zh_CN	Chinese, Simplified (P.R.C.)
zh_TW	Chinese, Traditional (Taiwan
zh_HK	Chinese, Traditional with HKSCS-2001 Extensions (Hong Kong)
hr_HR	Croatian (Republic of Croatia)
cs_CZ	Czech (Czech Republic)
da_DK	Danish (Denmark)
nl_BE	Dutch (Belgium)
nl_NL	Dutch (Netherlands)
en_AU	English (Australia)
en_CA	English (Canada)
en_IN	English (India)
en_IE	English (Ireland)
en_NZ	English (New Zealand)
en_ZA	English (South Africa)
en_GB	English (United Kingdom)
en_EN	English (United Kingdom, Euro Currency)
en_US	English (United States)
fi_FI	Finnish (Finland)
fr_BE	French (Belgium)
fr_CA	French (Canada)
fr_FR	French (France)
fr_LU	French (Luxembourg)
fr_CH	French (Switzerland)
de_AT	German (Austria)
de_DE	German (Germany)
de_LU	German (Luxembourg)
de_CH	German (Switzerland)
el_GR	Greek (Greece)
hu_HU	Hungarian (Hungary)
it_IT	Italian (Italy)
it_CH	Italian (Switzerland)
ja_JP	Japanese (Japan)
ko_KR	Korean (Korea)
no_NO	Norwegian (Norway)
no_NO_NY	Norwegian (Norway, Nynorsk)
pl_PL	Polish (Poland)
pt_BR	Portuguese (Brazil)
pt_PT	Portuguese (Portugal)
ro_RO	Romanian (Romania)
sh_BA	Serbo-Croatian (Bosnia and Herzegovina)
sh_HR	Serbo-Croatian (Croatia)
sh_CS	Serbo-Croatian (Republic of Serbia and Montenegro)
sk_SK	Slovak (Slovak Republic)
es_AR	Spanish (Argentina)
da_DK	Spanish (Bolivia)
es_CL	Spanish (Chile)
es_CO	Spanish (Costa Rica)
es_DO	Spanish (Dominican Republic)
es_EC	Spanish (Ecuador)
es_SV	Spanish (El Salvador)
es_GT	Spanish (Guatemala)
es_HN	Spanish (Honduras)
es_MX	Spanish (Mexico)
es_NI	Spanish (Nicaragua)
es_PA	Spanish (Panama)
es_PY	Spanish (Paraguay)
es_PE	Spanish (Peru)
es_PR	Spanish (Puerto Rico)
es_ES	Spanish (Spain)
es_UY	Spanish (Uruguay
es_VE	Spanish (Venezuela)
sv_SE	Swedish (Sweden)
tr_TR	Turkish (Turkey)