|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.adobe.livecycle.barcodedforms.client.BarcodedFormsServiceClient
public class BarcodedFormsServiceClient
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 in Programming with LiveCycle ES.
Constructor Summary | |
---|---|
BarcodedFormsServiceClient(ServiceClientFactory serviceClientFactory)
A constructor that creates a BarcodedFormsClient object. |
Method Summary | |
---|---|
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. |
List |
extractToXML(Document decoderXML,
Delimiter lineDelimiterType,
Delimiter fieldDelimiterType,
XMLFormat xmlFormat)
Converts delimited barcode data into XDP or XFDF XML data. |
String |
getServiceName()
Returns the name of the Barcoded Forms service. |
String |
getServiceVersion()
Returns the version of the Barcoded Forms service. |
void |
setServiceName(String serviceName)
Sets the name of the Barcoded Forms service. |
void |
setServiceVersion(String serviceVersion)
Sets the version of the Barcoded Forms service. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public BarcodedFormsServiceClient(ServiceClientFactory serviceClientFactory)
BarcodedFormsClient
object.
serviceClientFactory
- A ServiceClientFactory
object that contains connection properties. For information,
see Invoking LiveCycle Services.Method Detail |
---|
public String getServiceName()
public void setServiceName(String serviceName)
serviceName
- The new name of the Barcoded Forms service.public String getServiceVersion()
public void setServiceVersion(String serviceVersion)
serviceVersion
- The version of the Barcoded Forms service.public Document decode(Document document, Boolean pdf417, Boolean dataMatrix, Boolean qrCode, Boolean codabar, Boolean code128, Boolean code39, Boolean ean13, Boolean ean8, CharSet charSet) throws com.adobe.idp.dsc.DSCException
Document
object and returns a org.w3c.dom.Document
object that contains data that was retrieved from the barcode.
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.
org.w3c.dom.Document
object that contains data that was retrieved from the barcode.
com.adobe.idp.dsc.DSCException
- If an error occurred during this operation.public List extractToXML(Document decoderXML, Delimiter lineDelimiterType, Delimiter fieldDelimiterType, XMLFormat xmlFormat) throws com.adobe.idp.dsc.DSCException
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.
java.util.List
object that contains values for each barcode.
The key is barcode1
, barcode2
, and so on.
com.adobe.idp.dsc.DSCException
- If an error occurred during this operation.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |