com.adobe.icomm.assetplacement.dsc.client
Class AssetPlacementClient

java.lang.Object
  com.adobe.icomm.assetplacement.dsc.client.AssetPlacementClient

public class AssetPlacementClient
extends Object

The serviceClient for AssetPlacement exposes the service interface for use by java clients. It is configured using a ServiceClientFactory which will use the client configured transport to communicate with the Lc instance where the AssetPlacement is deployed.

See Also:

AssetPlacement

Constructor Summary

AssetPlacementClient(com.adobe.idp.dsc.clientsdk.ServiceClientFactory factory)
Constructor, requires the factory in order to invoke remote service.

Method Summary

com.adobe.idp.Document

generateInteractiveDocument(com.adobe.idp.Document packageDefinition, com.adobe.idp.Document documentTemplate, com.adobe.idp.Document printTemplate, com.adobe.idp.Document data, String batchScopeId, boolean clearCache) Generate an interactive document using package definition.

Methods inherited from class java.lang.Object

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

Constructor Detail

AssetPlacementClient

public AssetPlacementClient(com.adobe.idp.dsc.clientsdk.ServiceClientFactory factory)

Constructor, requires the factory in order to invoke remote service.

Parameters:

factory - is a ServiceClientFactory, configured by the client.

Method Detail

generateInteractiveDocument

public com.adobe.idp.Document generateInteractiveDocument(com.adobe.idp.Document packageDefinition,
                                                          com.adobe.idp.Document documentTemplate,
                                                          com.adobe.idp.Document printTemplate,
                                                          com.adobe.idp.Document data,
                                                          String batchScopeId,
                                                          boolean clearCache)
                                                   throws AssetPlacementException

Generate an interactive document using package definition.

Parameters:

packageDefinition - The package definition contains the xml directives for constructing the interactive document.

documentTemplate - The document template is the base document that contains your navigator.

printTemplate - The print template is the base xfa pdf or xdp document specifically designed for printing that will be rendered with data and packages as an attachment. It can be null.

data - The data is reflected in the interactive document and merged with the printTemplate. It can be null, if present within the package definition.

batchScopeId - An identifier used to group and cache resources required by the service. If null, no caching takes place.

clearCache - Forces cache associated with cacheScopeId to be cleared.

Returns:

The generated interactive document..

Throws:

AssetPlacementException