com.tsgrp.opencontent.universal.template

Interface IWordDocumentTemplating

All Known Implementing Classes:

AbstractWordDocumentTemplatingImpl, HotDocsWordDocumentTemplatingImpl, MailMergeWordDocumentTemplatingImpl

public interface IWordDocumentTemplating

API for manipulating FormTemplate docs

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>	getFields(java.lang.String ticket, java.lang.String objectId) Get all fields from a (non-mailmerge) docx word document/template
java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>	getMailMergeFields(java.lang.String ticket, java.lang.String objectId) Get all mailmerge fields from a docx word document/template
javax.activation.DataHandler	getMergeTemplate(java.lang.String ticket, java.lang.String templateName) returns DataHandler of the Word template
byte[]	performMailMerge(java.lang.String ticket, java.lang.String objectId, java.util.Map<java.lang.String,TemplateAnswer> fields) perform a mailmerge aginst the passed in word document and returns a PDF.
byte[]	performMailMergeAndReturnWordDocument(java.lang.String ticket, java.lang.String objectId, java.util.Map<java.lang.String,TemplateAnswer> fields) performs a mailmerge and returns the completed word document
byte[]	performMerge(java.lang.String ticket, java.lang.String objectId, java.util.Map<java.lang.String,TemplateAnswer> fields) perform a merge against the passed in template/package.
boolean	templateIdExists(java.lang.String templateName, java.lang.String ticket) checks for the existance of a template in a docbase.

Method Detail

getMailMergeFields

java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> getMailMergeFields(java.lang.String ticket,
                                                                                                    java.lang.String objectId)

Get all mailmerge fields from a docx word document/template

Parameters:

ticket - - cookie or parameter

objectId - - docbase object id (documentum or alfresco)

Returns:

map of all mailmerge fields (name, constraints, type)

performMailMerge

byte[] performMailMerge(java.lang.String ticket,
                        java.lang.String objectId,
                        java.util.Map<java.lang.String,TemplateAnswer> fields)

perform a mailmerge aginst the passed in word document and returns a PDF. To create an accurate map first, call getMailMergeFields

Parameters:

ticket - - cookie or parameter

fields - - map of mailmerge keys and their values

objectId - - docbase object id (documentum or alfresco)

Returns:

word doc with mailmerge fields fufilled

performMailMergeAndReturnWordDocument

byte[] performMailMergeAndReturnWordDocument(java.lang.String ticket,
                                             java.lang.String objectId,
                                             java.util.Map<java.lang.String,TemplateAnswer> fields)

performs a mailmerge and returns the completed word document

Parameters:

ticket - - cookie or parameter

objectId - - object Id of the template

fields - - mailmerge keys and their values

Returns:

getFields

java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> getFields(java.lang.String ticket,
                                                                                           java.lang.String objectId)

Get all fields from a (non-mailmerge) docx word document/template

Parameters:

ticket - - cookie or parameter

objectId - - docbase object id (documentum or alfresco)

Returns:

map of all template fields (name, constraints, type)

performMerge

byte[] performMerge(java.lang.String ticket,
                    java.lang.String objectId,
                    java.util.Map<java.lang.String,TemplateAnswer> fields)

perform a merge against the passed in template/package.

Parameters:

ticket - - cookie or parameter

fields - - map of template merge keys and their values

objectId - - docbase object id (documentum or alfresco) of template/package

Returns:

word doc with mailmerge fields fufilled

templateIdExists

boolean templateIdExists(java.lang.String templateName,
                         java.lang.String ticket)

checks for the existance of a template in a docbase.

Parameters:

templateName - - cookie or parameter

ticket - - map of template merge keys and their values

Returns:

true/false based on whether a template exists based on the passed in templateName

getMergeTemplate

javax.activation.DataHandler getMergeTemplate(java.lang.String ticket,
                                              java.lang.String templateName)

returns DataHandler of the Word template

Parameters:

ticket - - map of template merge keys and their values

templateName - - cookie or parameter

Returns:

DataHandler of the Word template