Package com.adobe.livecycle.barcodedforms.client
Classpublic class BarcodedFormsServiceClient
InheritanceBarcodedFormsServiceClient Inheritance Object

Enables the creation of a Java object that can invoke operations that belong to the Barcoded Forms service. With the Barcoded Forms service, you can add two-dimensional (2D) barcodes to interactive PDF forms. You can then publish the barcoded forms to a website or distribute them by email or CD. When a user fills a barcoded form using Adobe Reader, Acrobat Professional, or Acrobat Standard, the barcode is updated automatically to encode the user-supplied form data. The user can submit the form electronically, or print it to paper and submit it by mail, fax, or hand. You can later extract the user-supplied data as part of an automated workflow, routing the data among approval processes and business systems.

Using a BarcodedFormsClient object, you can decode data from barcodes located within a form. You can also convert the data that was extracted from the barcode into XDP or XFDF XML data. For information, see Working With the Barcoded Forms Service.


Public Methods
 MethodDefined by
  
BarcodedFormsServiceClient(ServiceClientFactory serviceClientFactory)
A constructor that creates a BarcodedFormsClient object.
BarcodedFormsServiceClient
  
Document decode(Document document, Boolean pdf417, Boolean dataMatrix, Boolean qrCode, Boolean codabar, Boolean code128, Boolean code39, Boolean ean13, Boolean ean8, CharSet charSet)
Decodes all the barcodes in a Document object and returns a org.w3c.dom.Document object that contains data that was retrieved from the barcode.
BarcodedFormsServiceClient
  
List extractToXML(Document decoderXML, Delimiter lineDelimiterType, Delimiter fieldDelimiterType, XMLFormat xmlFormat)
Converts delimited barcode data into XDP or XFDF XML data.
BarcodedFormsServiceClient
  
String getServiceName()
Returns the name of the Barcoded Forms service.
BarcodedFormsServiceClient
  
String getServiceVersion()
Returns the version of the Barcoded Forms service.
BarcodedFormsServiceClient
  
void setServiceName(String serviceName)
Sets the name of the Barcoded Forms service.
BarcodedFormsServiceClient
  
void setServiceVersion(String serviceVersion)
Sets the version of the Barcoded Forms service.
BarcodedFormsServiceClient
Constructor Detail
BarcodedFormsServiceClient()
public BarcodedFormsServiceClient(ServiceClientFactory serviceClientFactory)

A constructor that creates a BarcodedFormsClient object.

Parameters
serviceClientFactory — A ServiceClientFactory object that contains connection properties. For information, see Invoking LiveCycle Services.
Method Detail
decode()
public Document decode(Document document, Boolean pdf417, Boolean dataMatrix, Boolean qrCode, Boolean codabar, Boolean code128, Boolean code39, Boolean ean13, Boolean ean8, CharSet charSet)

Decodes all the barcodes in a Document object and returns a org.w3c.dom.Document object that contains data that was retrieved from the barcode.

Parameters

document — A com.adobe.idp.Document object that represents a PDF document that contains a barcode to decode.
 
pdf417 — A java.lang.Boolean object that when set to true, decodes PDF417 barcodes.
 
dataMatrix — A java.lang.Boolean object that when set to true, decodes data matrix barcodes.
 
qrCode — A java.lang.Boolean object that when set to true, decodes QR code barcodes.
 
codabar — A java.lang.Boolean object that when set to true, decodes Codabar barcodes.
 
code128 — A java.lang.Boolean object that when set to true, decodes code 128 barcodes.
 
code39 — A java.lang.Boolean object that when set to true, decodes code 39 barcodes.
 
ean13 — A java.lang.Boolean object that when set to true, decodes EAN-13 barcodes.
 
ean8 — A java.lang.Boolean object that when set to true, decodes EAN-8 barcodes.
 
charSet — A com.adobe.livecycle.barcodedforms.CharSet enumeration. The character set encoding value used in the barcode.

Returns
An org.w3c.dom.Document object that contains data that was retrieved from the barcode.

Throws
DSCException — If an error occurred during this operation.
extractToXML() 
public List extractToXML(Document decoderXML, Delimiter lineDelimiterType, Delimiter fieldDelimiterType, XMLFormat xmlFormat)

Converts delimited barcode data into XDP or XFDF XML data. This allows data that was retrieved from barcodes to be used in other LiveCycle service operations that require XDP or XFDF XML data.

Parameters

decoderXML — A org.w3c.dom.Document object that contains delimited barcode data.
 
lineDelimiterType — A com.adobe.livecycle.barcodedforms.Delimiter enumeration. The type of the line delimiter.
 
fieldDelimiterType — A com.adobe.livecycle.barcodedforms.Delimiter enumeration. The type of the field delimiter.
 
xmlFormat — A com.adobe.livecycle.barcodedforms.XMLFormat enumeration. Specifies whether to convert delimited barcode data into XDP or XFDF XML data.

Returns
A java.util.List object that contains values for each barcode. The key is barcode1, barcode2, and so on.

Throws
DSCException — If an error occurred during this operation.
getServiceName() 
public String getServiceName()

Returns the name of the Barcoded Forms service.

Returns
A string value that represents the name of the Barcoded Forms service.
getServiceVersion() 
public String getServiceVersion()

Returns the version of the Barcoded Forms service.

Returns
The version of the Barcoded Forms service.
setServiceName() 
public void setServiceName(String serviceName)

Sets the name of the Barcoded Forms service.

Parameters

serviceName — The new name of the Barcoded Forms service.

setServiceVersion() 
public void setServiceVersion(String serviceVersion)

Sets the version of the Barcoded Forms service.

Parameters

serviceVersion — The version of the Barcoded Forms service.




© 2004-2006 Adobe Systems Incorporated. All rights reserved.
Thu Sep 27 2007, 8:38 AM GMT-07:00

 

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/livecycle/es/sdkHelp/programmer/javadoc/com/adobe/livecycle/barcodedforms/client/BarcodedFormsServiceClient.html