com.adobe.icomm.assetplacement.dsc
Interface AssetPlacement

public interface AssetPlacement

The AssetPlacement service takes an package definition, a base document that most likely will contain a custom navigator and optionally other items. It will fetch collateral documents as defined in the definition, and produce an interactive document.

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.
com.adobe.idp.Document	generateInteractiveDocumentOrchestrated(com.adobe.idp.Document packageDefinition, com.adobe.idp.Document documentTemplate, com.adobe.idp.Document printTemplate, com.adobe.idp.Document data, String batchScopeId, boolean clearCache, PATExecutionContext executionContext) Generate an interactive document using package definition, orchestrated.

Method Detail

generateInteractiveDocument

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

generateInteractiveDocumentOrchestrated

com.adobe.idp.Document generateInteractiveDocumentOrchestrated(com.adobe.idp.Document packageDefinition,
                                                               com.adobe.idp.Document documentTemplate,
                                                               com.adobe.idp.Document printTemplate,
                                                               com.adobe.idp.Document data,
                                                               String batchScopeId,
                                                               boolean clearCache,
                                                               PATExecutionContext executionContext)
                                                               throws AssetPlacementException

Generate an interactive document using package definition, orchestrated.

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.

executionContext - Passed to act as a source for assets defined with "process_data" values.

Returns:

The generated interactive document.

Throws:

AssetPlacementException