com.adobe.livecycle.output.client
Class OutputOptionsSpec

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

All Implemented Interfaces:

java.io.Serializable

public class OutputOptionsSpec
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, such as a PostScript file.

See Also:

Serialized Form

Field Summary

static java.lang.String	MULTIPLE_OUTPUT Represents multiple output streams where one output stream for each data record is generated.
static java.lang.String	PCL_FORMAT Represents a PCL output stream.
static java.lang.String	POSTSCRIPT_FORMAT Represents a PostScript output stream.
static java.lang.String	SINGLE_OUTPUT Represents a single output stream where all data records are merged in single output stream.
static java.lang.String	SINGLE_OUTPUT_WITH_RETURN_DATA Represents a single stream that is generated and directed to specified destination and is also returned back to caller.
static java.lang.String	ZPL_FORMAT Represents a ZPL output stream.

Constructor Summary

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

OutputOptionsSpec(java.lang.String sOptions)
A constructor that sets specified print specification options.

OutputOptionsSpec(java.lang.String requestor, java.lang.String serverPrintSpec, java.lang.String dataFile, java.lang.String recordName, int recordLevel, int lookAhead, java.util.List rules, java.lang.String form, java.lang.String contentRoot, java.lang.String xci, int copies, java.lang.String printFormat, java.lang.String printUri, java.lang.String fileUri, java.lang.String emailRecipients, java.lang.String emailSubject, java.lang.String emailServer, java.lang.String emailBody, boolean waitForResponse, java.lang.String outputStream, java.lang.String pagination, java.lang.String staple, java.lang.String pageOffsetX, java.lang.String pageOffsetY, java.lang.String outputBin, java.lang.String outputJog, java.lang.String metaDataSpecFile, boolean recordLevelMetaData, java.lang.String recordIdField, java.lang.String lpdURI, java.lang.String printerQueueName, java.lang.String locale, java.lang.String charset)
A constructor that sets all print specification options.

OutputOptionsSpec(java.lang.String requestor, java.lang.String serverPrintSpec, java.lang.String dataFile, java.lang.String recordName, int recordLevel, int lookAhead, java.util.List rules, java.lang.String form, java.lang.String contentRoot, java.lang.String xci, int copies, java.lang.String printFormat, java.lang.String printUri, java.lang.String fileUri, java.lang.String emailRecipients, java.lang.String emailSubject, java.lang.String emailServer, java.lang.String emailBody, boolean waitForResponse, java.lang.String outputStream, java.lang.String pagination, java.lang.String staple, java.lang.String pageOffsetX, java.lang.String pageOffsetY, java.lang.String outputBin, java.lang.String outputJog, java.lang.String metaDataSpecFile, boolean recordLevelMetaData, java.lang.String recordIdField, java.lang.String lpdURI, java.lang.String printerQueueName, java.lang.String locale, java.lang.String charset, 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	getContentRoot() Returns the content root for the form design and its related collateral files.
int	getCopies() Returns the number of copies that the Output service prints.
java.lang.String	getDataFile() Returns the data file URI.
java.lang.String	getEmailBody() Returns the body of an email message.
java.lang.String	getEmailRecipients() Returns the email recipients to whom documents are sent as attachments.
java.lang.String	getEmailServer() Returns the email server that is used to send email messages.
java.lang.String	getEmailSubject() Specifies the subject that is displayed within email messages sent to email recipients.
java.lang.String	getFileUri() Returns a file URI value that the Output service uses to write the output stream to a file.
java.lang.String	getForm() Returns the name of the form design that is used to generate an output stream.
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() Retrieves the value used to generate metadata.
java.lang.String	getOption(java.lang.String key) Returns the value of a specified print specification option.
java.lang.String	getOptions() Returns a string value that specifies the print specification options that are set.
java.lang.String	getOptionString() Returns an option string that is used to generate output.
java.lang.String	getOutputBin() Gets the outputBin XCI value.
java.lang.String	getOutputJog() Gets the Jog XCI value.
java.lang.String	getOutputStream() Returns whether the Output service creates a single or multiple output streams.
java.lang.String	getPageOffsetX() Gets the pageOffsetX XCI value.
java.lang.String	getPageOffsetY() Gets the pageOffsetY XCI value.
java.lang.String	getPagination() Returns the pagination XCI 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	getPrintFormat() Returns the format of the output stream.
java.lang.String	getPrintUri() Returns the destination for the print 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.lang.String	getRequestor() Returns the initiator of this request.
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.
java.lang.String	getStaple() Returns the staple XCI value.
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	getXci() Returns the XCI file to use when generating a document output stream.
boolean	isBatch() Returns true if the input data file contains batch records (if either the recordName value or the recordLevel value is set).
boolean	isEnableViewerPreferences() This returns the value that specifies whether the PDF Print Options specified during template design would be used or not.
boolean	isMultipleOutput() Returns true if the Output service creates multiple output streams.
boolean	isPCLFormat() Returns true if the output format is PCL.
boolean	isPostScriptFormat() Returns true if the output format is Postscript.
boolean	isRecordLevelMetaData() Determines whether the record level metadata is set.
boolean	isRetainPDFFormState() This returns the value which specifies whether the form state is retained or not during the operation.
boolean	isSingleOutput() Returns true if the Output service creates a single output stream.
boolean	isWaitForResponse() Deprecated. Use the setSynchronous() method.
boolean	isZPLFormat() Returns true if the output format is ZPL.
java.lang.String	rulesToString(java.util.List rules) Converts a java.util.List to a string value.
void	setCharset(java.lang.String charset) Sets the character set used to encode the output byte stream.
void	setContentRoot(java.lang.String contentRoot) Sets the content root in which the form design and its related collateral files are located.
void	setCopies(int copies) Sets the number of copies to print.
void	setDataFile(java.lang.String dataFile) Sets the data file URI.
void	setEmailBody(java.lang.String emailBody) Sets the body of an email message.
void	setEmailRecipients(java.lang.String emailRecipients) Sets the email recipients separated by commas or semi colons.
void	setEmailServer(java.lang.String emailServer) Sets the email server that is used to send email messages.
void	setEmailSubject(java.lang.String emailSubject) Sets the subject that is displayed within email messages sent to email recipients.
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	setForm(java.lang.String form) Sets the form design that is used to generate an output stream.
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) Sets the lookahead bytes used for the search rules.
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 value used to generate metadata.
void	setOptionString(java.lang.String optionString) Sets an option string that is used to generate output.
void	setOutputBin(java.lang.String outputBin) Sets the outputBin XCI value that is used to enable the print driver to select the appropriate output bin.
void	setOutputJog(java.lang.String outputJog) Sets the Jog XCI value that is used to set what output pages are physically shifted in the output tray.
void	setOutputStream(java.lang.String outputStream) Specifies whether the Output service creates a single or multiple output streams.
void	setPageOffsetX(java.lang.String pageOffsetX) Sets the pageOffsetX XCI value.
void	setPageOffsetY(java.lang.String pageOffsetY) Sets the pageOffsetY XCI value.
void	setPagination(java.lang.String pagination) Sets the pagination XCI 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	setPrintFormat(java.lang.String printFormat) Sets the format of the output stream.
void	setPrintUri(java.lang.String printUri) 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 whether the record level metadata is set.
void	setRecordName(java.lang.String recordName) Sets the element name (located within the input data file) that identifies the beginning of a record.
void	setRequestor(java.lang.String requestor) Sets the initiator of this request.
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	setStaple(java.lang.String staple) Sets the staple XCI value that is set when a stapler is used.
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	setWaitForResponse(boolean waitForResponse) Deprecated. Use the setSynchronous() method.
void	setXci(java.lang.String xci) Sets the XCI file to use when generating a document output stream.
java.util.List	stringToRules(java.lang.String rules) Converts string value that specifies rules to a java.util.List object.
java.lang.String	toString() Creates a string represenation of this class.
void	updateOptionsBean(java.lang.String options) For internal use only.
void	updateOptionsBean(java.lang.String key, java.lang.String value) For internal use only.

Methods inherited from class java.lang.Object

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

Field Detail

SINGLE_OUTPUT

public static final java.lang.String SINGLE_OUTPUT

Represents a single output stream where all data records are merged in single output stream.

See Also:

Constant Field Values

SINGLE_OUTPUT_WITH_RETURN_DATA

public static final java.lang.String SINGLE_OUTPUT_WITH_RETURN_DATA

Represents a single stream that is generated and directed to specified destination and is also returned back to caller.

See Also:

Constant Field Values

MULTIPLE_OUTPUT

public static final java.lang.String MULTIPLE_OUTPUT

Represents multiple output streams where one output stream for each data record is generated.

See Also:

Constant Field Values

POSTSCRIPT_FORMAT

public static final java.lang.String POSTSCRIPT_FORMAT

Represents a PostScript output stream.

See Also:

Constant Field Values

PCL_FORMAT

public static final java.lang.String PCL_FORMAT

Represents a PCL output stream.

See Also:

Constant Field Values

ZPL_FORMAT

public static final java.lang.String ZPL_FORMAT

Represents a ZPL output stream.

See Also:

Constant Field Values

Constructor Detail

OutputOptionsSpec

public OutputOptionsSpec()

A constructor that that does not set print specification options.

OutputOptionsSpec

public OutputOptionsSpec(java.lang.String sOptions)

A constructor that sets specified print specification options.

Parameters:

sOptions - A string value that represents print specification options that you want to set. You can specify multiple options by separating each option and value with a comma. For example, option=value,option=value,option=value.

OutputOptionsSpec

public OutputOptionsSpec(java.lang.String requestor,
                         java.lang.String serverPrintSpec,
                         java.lang.String dataFile,
                         java.lang.String recordName,
                         int recordLevel,
                         int lookAhead,
                         java.util.List rules,
                         java.lang.String form,
                         java.lang.String contentRoot,
                         java.lang.String xci,
                         int copies,
                         java.lang.String printFormat,
                         java.lang.String printUri,
                         java.lang.String fileUri,
                         java.lang.String emailRecipients,
                         java.lang.String emailSubject,
                         java.lang.String emailServer,
                         java.lang.String emailBody,
                         boolean waitForResponse,
                         java.lang.String outputStream,
                         java.lang.String pagination,
                         java.lang.String staple,
                         java.lang.String pageOffsetX,
                         java.lang.String pageOffsetY,
                         java.lang.String outputBin,
                         java.lang.String outputJog,
                         java.lang.String metaDataSpecFile,
                         boolean recordLevelMetaData,
                         java.lang.String recordIdField,
                         java.lang.String lpdURI,
                         java.lang.String printerQueueName,
                         java.lang.String locale,
                         java.lang.String charset,
                         ResourcesInPDF useResourcesInPDF)

A constructor that sets all print specification options.

OutputOptionsSpec

public OutputOptionsSpec(java.lang.String requestor,
                         java.lang.String serverPrintSpec,
                         java.lang.String dataFile,
                         java.lang.String recordName,
                         int recordLevel,
                         int lookAhead,
                         java.util.List rules,
                         java.lang.String form,
                         java.lang.String contentRoot,
                         java.lang.String xci,
                         int copies,
                         java.lang.String printFormat,
                         java.lang.String printUri,
                         java.lang.String fileUri,
                         java.lang.String emailRecipients,
                         java.lang.String emailSubject,
                         java.lang.String emailServer,
                         java.lang.String emailBody,
                         boolean waitForResponse,
                         java.lang.String outputStream,
                         java.lang.String pagination,
                         java.lang.String staple,
                         java.lang.String pageOffsetX,
                         java.lang.String pageOffsetY,
                         java.lang.String outputBin,
                         java.lang.String outputJog,
                         java.lang.String metaDataSpecFile,
                         boolean recordLevelMetaData,
                         java.lang.String recordIdField,
                         java.lang.String lpdURI,
                         java.lang.String printerQueueName,
                         java.lang.String locale,
                         java.lang.String charset)

A constructor that sets all print specification options.

Method Detail

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:

enablePrintOptions -

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:

EmbeddedPDFResources

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

getEmailRecipients

public java.lang.String getEmailRecipients()

Returns the email recipients to whom documents are sent as attachments.

Returns:

A string value that specifies the email recipients.

setEmailRecipients

public void setEmailRecipients(java.lang.String emailRecipients)

Sets the email recipients separated by commas or semi colons. This value specifies recipients to whom documents are sent by email as attachments.

Parameters:

emailRecipients - A list of email recipients separated by commas or semi colons.

getEmailSubject

public java.lang.String getEmailSubject()

Specifies the subject that is displayed within email messages sent to email recipients. Returns A string value that specifies the subject value.

setEmailSubject

public void setEmailSubject(java.lang.String emailSubject)

Sets the subject that is displayed within email messages sent to email recipients.

Parameters:

emailSubject - A string value that specifies the subject.

getEmailServer

public java.lang.String getEmailServer()

Returns the email server that is used to send email messages.

Returns:

A string value that specifies the mail server.

setEmailServer

public void setEmailServer(java.lang.String emailServer)

Sets the email server that is used to send email messages.

Parameters:

emailServer - A string value that specifies the mail server.

getEmailBody

public java.lang.String getEmailBody()

Returns the body of an email message.

Returns:

A string value that specifies the body of an email message.

setEmailBody

public void setEmailBody(java.lang.String emailBody)

Sets the body of an email message.

Parameters:

emailBody - A string value that represents the body of an email message.

getCopies

public int getCopies()

Returns the number of copies that the Output service prints.

Returns:

An integer value that represents the number of copies.

setCopies

public void setCopies(int copies)

Sets the number of copies to print. The default value is 1.

Parameters:

copies - The number of copies to print.

getPrintFormat

public java.lang.String getPrintFormat()

Returns the format of the output stream. The following are valid values:

• PDF
• PCL
• PostScript
• ZPL

Returns:

The format of the output stream.

setPrintFormat

public void setPrintFormat(java.lang.String printFormat)

Sets the format of the output stream. The following are valid values:

• PDF
• PCL
• PostScript
• ZPL

Parameters:

printFormat - The format of the output stream.

isPostScriptFormat

public boolean isPostScriptFormat()

Returns true if the output format is Postscript.

Returns:

A Boolean value that specifies the format of the output stream.

isPCLFormat

public boolean isPCLFormat()

Returns true if the output format is PCL.

Returns:

A Boolean value that specifies the format of the output stream.

isZPLFormat

public boolean isZPLFormat()

Returns true if the output format is ZPL.

Returns:

A Boolean value that specifies the format of the output stream.

getPrintUri

public java.lang.String getPrintUri()

Returns 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.

Returns:

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

setPrintUri

public void setPrintUri(java.lang.String printUri)

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:

printUri - 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.pcl.

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.pcl. In this situation, the Output service writes the output stream to a file named output.pcl that is located in c:/save.

To see this method used in a code example, see the Printing to a file using the Java API quick start in Programming with LiveCycle ES4.

Parameters:

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

getOptionString

public java.lang.String getOptionString()

Returns an option string that is used to generate output.

Returns:

An option string that is used when generating output.

setOptionString

public void setOptionString(java.lang.String optionString)

Sets an option string that is used to generate output. For example, to use a custom XDC file, you specify the following value XDCURI=[URI location of the XDC file]. For more information about the options that you can set, see com.adobe.livecycle.output.client.RenderOptionsSpecConstants.

Parameters:

optionString - An option string that is used when generating output.

isWaitForResponse

public boolean isWaitForResponse()

Deprecated. Use the setSynchronous() method.

Returns true if the Output service waits for a response.

Returns:

A Boolean value that specifies if the Output service waits for a response.

See Also:

OutputClient.setSynchronous()

setWaitForResponse

public void setWaitForResponse(boolean waitForResponse)

Deprecated. Use the setSynchronous() method.

Sets whether the Output service waits for a response.

Parameters:

waitForResponse - A Boolean value that specifies if the Output service waits for a response.

See Also:

OutputClient.setSynchronous()

getOutputStream

public java.lang.String getOutputStream()

Returns whether the Output service creates a single or multiple output streams. The following values are valid:

• single Creates a single output stream. This value is the default.
• multiple Creates multiple output streams.

Returns:

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

setOutputStream

public void setOutputStream(java.lang.String outputStream)

Specifies whether the Output service creates a single or multiple output streams. The following values are valid:

• single Creates a single output stream. This value is the default.
• multiple Creates multiple output streams.

If a data file has 10 records and this element is set to multiple, 10 output streams are created. If this element is set to single, all records are written to a single output stream.

A single print stream is valid for printer output (see the #setPrintUri() method) and file output (see the #setFileUri() method). A single print stream containing multiple records cannot be sent as an email file attachment.

Parameters:

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

isSingleOutput

public boolean isSingleOutput()

Returns true if the Output service creates a single output stream.

Returns:

A Boolean value that specifies whether the Output service creates a single output stream.

isMultipleOutput

public boolean isMultipleOutput()

Returns true if the Output service creates multiple output streams.

Returns:

A Boolean value that specifies if the Output service creates multiple output streams.

getRequestor

public java.lang.String getRequestor()

Returns the initiator of this request. This value must be a valid InetAddress value.

Returns:

A string value that represents the initiator of this request.

setRequestor

public void setRequestor(java.lang.String requestor)

Sets the initiator of this request. When the Output service sends email messages, the requestor is used to define the from property. This value must be a valid InetAddress.

Parameters:

requestor - A string value that represents the initiator of this request.

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.

getDataFile

public java.lang.String getDataFile()

Returns the data file URI. A data file URI defines the location of server-accessible data to use to merge with the form design.

Returns:

A string value that represents a data file URI.

setDataFile

public void setDataFile(java.lang.String dataFile)

Sets the data file URI. A data file URI defines the location of server-accessible data to use to merge with the form design. If a Document object that contains data is passed to the OutputClient.generateOutput() method's inDataDoc parameter, then this value is ignored and the data located in the Document object is used instead.

Parameters:

dataFile - A string value that represents the URI of a data file.

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. For information about working with record batches, see Creating Print Output Streams.

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.

isBatch

public boolean isBatch()

Returns true if the input data file contains batch records (if either the recordName value or the recordLevel value is set).

Returns:

A Boolean value that specifies whether the input data file contains batch records.

getForm

public java.lang.String getForm()

Returns the name of the form design that is used to generate an output stream.

Returns:

A string value that represents the form design.

setForm

public void setForm(java.lang.String form)

Sets the form design that is used to generate an output stream. This value is used with the contentRoot value.

Parameters:

form - A string value that represents a form design.

getContentRoot

public java.lang.String getContentRoot()

Returns the content root for the form design and its related collateral files.

Returns:

A string value that specifies the content root.

setContentRoot

public void setContentRoot(java.lang.String contentRoot)

Sets the content root in which the form design and its related collateral files are located. This value is used with the form value to specifiy a form design to use to generate an output stream.

Parameters:

contentRoot - A string value that specifies the content root.

See Also:

setForm()

getXci

public java.lang.String getXci()

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

Returns:

A string value that specifies the XCI file to use.

setXci

public void setXci(java.lang.String xci)

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:

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

getPagination

public java.lang.String getPagination()

Returns the pagination XCI value. The following values are valid:

• simplex(default)
• duplexShortEdge
• duplexLongEdge

Returns:

A string value that represents the pagination XCI value.

setPagination

public void setPagination(java.lang.String pagination)

Sets the pagination XCI value. The following values are valid:

• simplex(default)
• duplexShortEdge
• duplexLongEdge

Parameters:

pagination - A string value that represents the pagination to set.

getStaple

public java.lang.String getStaple()

Returns the staple XCI value. This XCI option is set when a stapler is used. This option can be specified in the configuration model by the staple element and is only used for PS and PCL printers.

Returns:

A string value that represents the staple XCI value.

setStaple

public void setStaple(java.lang.String staple)

Sets the staple XCI value that is set when a stapler is used. This option can be specified in the configuration model by the staple element and is only used for PS and PCL printers.

Parameters:

staple - A string value that represents the staple XCI value.

getOutputJog

public java.lang.String getOutputJog()

Gets the Jog XCI value. This XCI option is set when output pages should be jogged (physically shifted in the output tray). This option is for PS and PCL printers only.

Returns:

A string value that represents the Jog XCI value.

setOutputJog

public void setOutputJog(java.lang.String outputJog)

Sets the Jog XCI value that is used to set what output pages are physically shifted in the output tray. This option is for PS and PCL printers only.

Parameters:

outputJog - A string value that represents the Jog XCI value.

getOutputBin

public java.lang.String getOutputBin()

Gets the outputBin XCI value. This value is used to enable the print driver to select the appropriate output bin.

Returns:

A string value that represents the outputBin XCI value.

setOutputBin

public void setOutputBin(java.lang.String outputBin)

Sets the outputBin XCI value that is used to enable the print driver to select the appropriate output bin.

Parameters:

outputBin - A string value that represents the outputBin XCI value.

getPageOffsetX

public java.lang.String getPageOffsetX()

Gets the pageOffsetX XCI value. This value is set when you want to print the job on pre-printed paper and you want to change the origin (for example, the default page offsets for that particular job). This value overrides the page offsets defined in the XDC file which represents non-printable area for any PCL device. This option is for PCL devices only.

Returns:

A string value that represents the pageOffsetX XCI value.

setPageOffsetX

public void setPageOffsetX(java.lang.String pageOffsetX)

Sets the pageOffsetX XCI value. This value is set when you want to print the job on pre-printed paper and you want to change the origin (for example, the default page offsets for that particular job). This value overrides the page offsets defined in the XDC file which represents non-printable area for any PCL device. This option is for PCL devices only.

Parameters:

pageOffsetX - A string value that represents the pageOffsetX XCI value.

getPageOffsetY

public java.lang.String getPageOffsetY()

Gets the pageOffsetY XCI value. This value is set when you want to print the job on pre-printed paper and you want to change the origin (for example, the default page offsets for that particular job). This value overrides the page offsets defined in the XDC file which represents non-printable area for any PCL device. This option is for PCL devices only.

Returns:

A string value that represents the pageOffsetY XCI value.

setPageOffsetY

public void setPageOffsetY(java.lang.String pageOffsetY)

Sets the pageOffsetY XCI value. This value is set when you want to print the job on pre-printed paper and you want to change the origin (for example, the default page offsets for that particular job). This value overrides the page offsets defined in the XDC file which represents non-printable area for any PCL device. This option is for PCL devices only.

Parameters:

pageOffsetY - A string value that represents the pageOffsetY XCI value.

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)

Sets 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. The default value is 500.

Parameters:

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

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. For information about working with search rules, see Creating Print Output Streams.

Parameters:

rules - A list of search rules.

getMetaDataSpecFile

public java.lang.String getMetaDataSpecFile()

Retrieves the value used to generate metadata. For information, see Creating Print Output Streams.

Returns:

A string value that is used to generate metadata.

setMetaDataSpecFile

public void setMetaDataSpecFile(java.lang.String metaDataSpecFile)

Sets the value used to generate metadata. For information, see Creating Print Output Streams.

Parameters:

metaDataSpecFile - A string value that is used to generate metadata.

isRecordLevelMetaData

public boolean isRecordLevelMetaData()

Determines whether the record level metadata is set.

Returns:

true if the record level metadata is set, false otherwise.

setRecordLevelMetaData

public void setRecordLevelMetaData(boolean recordLevelMetaData)

Sets whether the record level metadata is set. This value is used to generate metadata. For information, see Creating Print Output Streams.

Parameters:

recordLevelMetaData - true if the record level metadata is set, false otherwise.

setLazyLoading

public void setLazyLoading(java.lang.Boolean lazyLoading)

Sets the Lazy Loading parameter

Parameters:

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

getLazyLoading

public java.lang.Boolean getLazyLoading()

Decides whether Lazy Loading is set.

Returns:

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

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

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)

getOption

public java.lang.String getOption(java.lang.String key)

Returns the value of a specified print specification option.

Parameters:

key - The name of the option for which a value is retrieved.

Returns:

A string value that represents the value of the specified option.

rulesToString

public java.lang.String rulesToString(java.util.List rules)

Converts a java.util.List to a string value.

Parameters:

rules - A java.util.List object that contain rules.

Returns:

A string value that contains rules.

stringToRules

public java.util.List stringToRules(java.lang.String rules)

Converts string value that specifies rules to a java.util.List object.

Parameters:

rules - A string value that contains rules.

Returns:

A java.util.List object that contain rules.

getOptions

public java.lang.String getOptions()

Returns a string value that specifies the print specification options that are set.

Returns:

A string value that specifies the print specification options that are set.

updateOptionsBean

public void updateOptionsBean(java.lang.String key,
                              java.lang.String value)
                       throws OutputException

For internal use only. Do not use.

Throws:

OutputException

updateOptionsBean

public void updateOptionsBean(java.lang.String options)

For internal use only. Do not use.

toString

public java.lang.String toString()

Creates a string represenation of this class.

Overrides:

toString in class java.lang.Object

Returns:

A string represenation of this class.

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:

OutputClient.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:

OutputClient.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:

OutputClient.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:

OutputClient.lprPrint()