com.adobe.livecycle.output.client
Class PDFOutputOptionsSpec

java.lang.Object
  extended by com.adobe.livecycle.output.client.PDFOutputOptionsSpec
All Implemented Interfaces:
Serializable

public class PDFOutputOptionsSpec
extends Object
implements 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 ES2.

See Also:
generatePDFOutput, Serialized Form

Constructor Summary
PDFOutputOptionsSpec()
          A constructor that does not set print specification options.
PDFOutputOptionsSpec(String serverPrintSpec, String recordName, int recordLevel, int lookAhead, List rules, String XCIURI, String printerURI, String fileURI, boolean generateManyFiles, String metaDataSpecFile, boolean recordLevelMetaData, String recordIdField, String lpdURI, String printerQueueName, String charset, String locale)
          A constructor that sets all print specification options.
 
Method Summary
 String getCharset()
          Gets the character set used to encode the output byte stream.
 String getFileURI()
          Returns a file URI value that the Output service uses to write the output stream to a file.
 Boolean getLazyLoading()
          Decides whether lazy loading is set.
 String getLocale()
          Gets a locale value
 int getLookAhead()
          Returns the lookahead bytes used for the search rules.
 String getLpdURI()
          Returns the specified Line Printer Daemon (LPD) URI when the network has a LP daemon running.
 String getMetaDataSpecFile()
          Returns the metaDataSpecFile value.
 String getPrinterQueueName()
          Returns the name of the printer queue that is used with the Line Printer Daemon (LPD) URI.
 String getPrinterURI()
          Returns the destination for the printed output.
 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.
 String getRecordName()
          Returns the element name (located within the input data file) that identifies the beginning of a batch of records.
 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.
 String getServerPrintSpec()
          Returns the print specification name.
 String getXCIURI()
          Returns the XCI file to use when generating a document output stream.
 boolean isGenerateManyFiles()
          Returns whether the Output service creates a single or multiple output streams.
 boolean isRecordLevelMetaData()
          Returns true if the recordLevelMetaData value is set.
 void setCharset(String charset)
          Sets the character set used to encode the output byte stream.
 void setFileURI(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(Boolean lazyLoading)
          Sets the lazy loading parameter.
 void setLocale(String locale)
          Sets the locale value
 void setLookAhead(int lookAhead)
           
 void setLpdURI(String lpdURI)
          Sets the specified Line Printer Daemon (LPD) URI when the network has a LP daemon running.
 void setMetaDataSpecFile(String metaDataSpecFile)
          Sets the metaDataSpecFile value.
 void setPrinterQueueName(String printerQueueName)
          Sets the name of the printer queue that is used with the Line Printer Daemon (LPD) URI.
 void setPrinterURI(String printerURI)
          Sets the destination for the print output.
 void setRecordIdField(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(String recordName)
          Sets the element name (located within the input data file) that identifies the beginning of a record.
 void setRules(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(String serverPrintSpec)
          Sets the print specification name.
 void setXCIURI(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(String serverPrintSpec,
                            String recordName,
                            int recordLevel,
                            int lookAhead,
                            List rules,
                            String XCIURI,
                            String printerURI,
                            String fileURI,
                            boolean generateManyFiles,
                            String metaDataSpecFile,
                            boolean recordLevelMetaData,
                            String recordIdField,
                            String lpdURI,
                            String printerQueueName,
                            String charset,
                            String locale)
A constructor that sets all print specification options.

Method Detail

getPrinterURI

public 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(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 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(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 ES2.

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

getServerPrintSpec

public 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(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 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(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 ES2.

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 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(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 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(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 ES2.

Parameters:
rules - A list of search rules.

getMetaDataSpecFile

public 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(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 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(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 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(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 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(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 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(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 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(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 String getLocale()
Gets a locale value

Returns:
A string value that represents the locale value.
See Also:
setLocale()

setLocale

public void setLocale(String locale)
Sets the locale value

Parameters:
locale - The locale value to set. The following table lists valid values:
LocaleDescription
zh_CNChinese, Simplified (P.R.C.)
zh_TWChinese, Traditional (Taiwan
zh_HKChinese, Traditional with HKSCS-2001 Extensions (Hong Kong)
hr_HRCroatian (Republic of Croatia)
cs_CZCzech (Czech Republic)
da_DKDanish (Denmark)
nl_BEDutch (Belgium)
nl_NLDutch (Netherlands)
en_AUEnglish (Australia)
en_CAEnglish (Canada)
en_INEnglish (India)
en_IEEnglish (Ireland)
en_NZEnglish (New Zealand)
en_ZAEnglish (South Africa)
en_GBEnglish (United Kingdom)
en_ENEnglish (United Kingdom, Euro Currency)
en_USEnglish (United States)
fi_FIFinnish (Finland)
fr_BEFrench (Belgium)
fr_CAFrench (Canada)
fr_FRFrench (France)
fr_LUFrench (Luxembourg)
fr_CHFrench (Switzerland)
de_ATGerman (Austria)
de_DEGerman (Germany)
de_LUGerman (Luxembourg)
de_CHGerman (Switzerland)
el_GRGreek (Greece)
hu_HUHungarian (Hungary)
it_ITItalian (Italy)
it_CHItalian (Switzerland)
ja_JPJapanese (Japan)
ko_KRKorean (Korea)
no_NONorwegian (Norway)
no_NO_NYNorwegian (Norway, Nynorsk)
pl_PLPolish (Poland)
pt_BRPortuguese (Brazil)
pt_PTPortuguese (Portugal)
ro_RORomanian (Romania)
sh_BASerbo-Croatian (Bosnia and Herzegovina)
sh_HRSerbo-Croatian (Croatia)
sh_CSSerbo-Croatian (Republic of Serbia and Montenegro)
sk_SKSlovak (Slovak Republic)
es_ARSpanish (Argentina)
da_DKSpanish (Bolivia)
es_CLSpanish (Chile)
es_COSpanish (Costa Rica)
es_DOSpanish (Dominican Republic)
es_ECSpanish (Ecuador)
es_SVSpanish (El Salvador)
es_GTSpanish (Guatemala)
es_HNSpanish (Honduras)
es_MXSpanish (Mexico)
es_NISpanish (Nicaragua)
es_PASpanish (Panama)
es_PYSpanish (Paraguay)
es_PESpanish (Peru)
es_PRSpanish (Puerto Rico)
es_ESSpanish (Spain)
es_UYSpanish (Uruguay
es_VESpanish (Venezuela)
sv_SESwedish (Sweden)
tr_TRTurkish (Turkey)