|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.adobe.livecycle.centralmigrationbridge.client.CentralMigrationBridgeServiceClient
public class CentralMigrationBridgeServiceClient
The CentralMigrationBridgeServiceClient
class lets you create a
CentralMigrationBridgeServiceClient
object that invokes operations supported by the
CentralMigrationBridge service. This service lets your organization
perform the following operations:
This class was added in LiveCycle ES2.
Constructor Summary | |
---|---|
CentralMigrationBridgeServiceClient(ServiceClientFactory serviceClientFactory)
A constructor that creates a CentralMigrationBridgeServiceClient object. |
Method Summary | |
---|---|
Document |
centralDataAccess(Document inData,
int maxBytesToProcess)
Converts a Central Field Nominated data file (DAT file)to XML data. |
CentralResult |
centralMerge(Document inTemplateDoc,
Document inDataDoc,
Document inPreambleDoc,
java.lang.String inDestination,
java.lang.String inIniFilePath,
java.lang.String inAllOtherOptions)
Merges data in various formats with electronic templates for printing. |
CentralResult |
centralTransformation(Document inDataDoc,
Document inDataModelDoc,
java.lang.String inIniFilePath,
java.lang.String inAllOtherOptions)
Reformats a data file into accepted data formats, which include field-nominated, fixed record, comma-delimited, or XML data by executing the jfTrans command. |
CentralResult |
centralXMLImport(Document inDataDoc,
java.lang.String inXCIFilePath,
java.lang.String inAllOtherOptions)
Transforms well-formed XML data into a field-nominated format. |
boolean |
isSynchronous()
For internal use only. |
void |
setSynchronous(boolean synchronous)
Sets the CentralMigrationBridge service to be invoked synchronously. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public CentralMigrationBridgeServiceClient(ServiceClientFactory serviceClientFactory)
CentralMigrationBridgeServiceClient
object.
serviceClientFactory
- A ServiceClientFactory
object that contains connection properties.
For information about setting connection properties, see Invoking LiveCycle Services using APIs
in Programming with LiveCycle ES4.Method Detail |
---|
public boolean isSynchronous()
public void setSynchronous(boolean synchronous)
synchronous
- A Boolean value that specifies whether the service is invoked synchronously.public CentralResult centralMerge(Document inTemplateDoc, Document inDataDoc, Document inPreambleDoc, java.lang.String inDestination, java.lang.String inIniFilePath, java.lang.String inAllOtherOptions) throws CentralMigrationBridgeException, com.adobe.idp.dsc.DSCException
inTemplateDoc
- A com.adobe.idp.Document
object that stores an input MDF template.inDataDoc
- A com.adobe.idp.Document
object that stores data to merge with the MDF template.inPreambleDoc
- A com.adobe.idp.Document
object that stores the preamble file to merge with the output file..inDestination
- A string value that specifies a location to send the output file to.
When a file location is specified, the file is saved to the location on the LiveCycle ES server
or network location. A file location, such as C:\mergedFiles\newmergefile.pcl is saved on the LiveCycle ES server.
When a printer location is specified, it must be an absolute address such as \\myprintername.inIniFilePath
- A string value that represents the location on the server or network of a custom jfMerge.ini file,
such as C:\custom\customjfMerge.ini. When no value is provided,
the default jfMerge.ini file located in the Central Pro Output Server installation folder is used.inAllOtherOptions
- A string value that represents additional command line options that can be added to affect
the processing of the jfMerge command. Each command line option must be separated by a space.
You can specify any command line options other than -apr,-all,-z.
com.adobe.idp.Document
object that represents the merged document if
printerLocation
is not specified, otherwise null.
CentralMigrationBridgeException
- If invalid operation specific values are specified such as specifying invalid input data.
com.adobe.idp.dsc.DSCException
- If a general exception is thrown due to invalid settings such as invalid connection properties.public CentralResult centralTransformation(Document inDataDoc, Document inDataModelDoc, java.lang.String inIniFilePath, java.lang.String inAllOtherOptions) throws CentralMigrationBridgeException, com.adobe.idp.dsc.DSCException
This method converts data created in ASCII format, including fixed length, character-delimited, overlay, and central proprietary field-nominated format.
inDataDoc
- A com.adobe.idp.Document
object that represents the data to transform.inDataModelDoc
- A document value that represents definition file describing how to reformat the data file.inIniFilePath
- A string value that represents the location of a custom ini file for the jfTrans command, such as C:\Custom\customjfTrans.ini.inAllOtherOptions
- A string value that represents additional command line options that can be added to
affect the processing of the jfTrans command.
Each command line option must be separated by a space. You can specify any command line options other than -apr,-all,-z.
com.adobe.idp.Document
object that represents the transformed data.
CentralMigrationBridgeException
- If invalid operation specific values are specified such as specifying invalid data to convert.
com.adobe.idp.dsc.DSCException
- If a general exception is thrown due to invalid settings such as invalid connection properties.public CentralResult centralXMLImport(Document inDataDoc, java.lang.String inXCIFilePath, java.lang.String inAllOtherOptions) throws CentralMigrationBridgeException, com.adobe.idp.dsc.DSCException
inDataDoc
- A com.adobe.idp.Document
object that represents XML data to transform.inXCIFilePath
- A string value that represents the path to a XCI file used in the transformation process.inAllOtherOptions
- A string value that represents additional command line options that can be added to affect the
processing of the xmlImport command. Each command line option must be separated by a space.
You can specify any command line options other than -config command line option.
CentralResult
object that stores the results of the operation.
CentralMigrationBridgeException
- If invalid operation specific values are specified such as specifying XML data that is not well formatted.
com.adobe.idp.dsc.DSCException
- If a general exception is thrown due to invalid settings such as invalid connection properties.public Document centralDataAccess(Document inData, int maxBytesToProcess) throws CentralMigrationBridgeException, com.adobe.idp.dsc.DSCException
inData
- A com.adobe.idp.Document
object that represents the Central field nominated data file (DAT file).maxBytesToProcess
- An integer value that specifies the number of bytes in the data file to process.
com.adobe.idp.Document
that contains XML data.
CentralMigrationBridgeException
- If invalid operation specific values are specified such as specifying an invalid central field nominated data file.
com.adobe.idp.dsc.DSCException
- If a general exception is thrown due to invalid settings such as invalid connection properties.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |