com.tsgrp.opencontent.universal.template

Class AbstractWordDocumentTemplatingImpl

java.lang.Object

com.tsgrp.opencontent.universal.template.AbstractWordDocumentTemplatingImpl

All Implemented Interfaces:

IWordDocumentTemplating

Direct Known Subclasses:

HotDocsWordDocumentTemplatingImpl, MailMergeWordDocumentTemplatingImpl

public abstract class AbstractWordDocumentTemplatingImpl
extends java.lang.Object
implements IWordDocumentTemplating

Constructor Summary

Constructors

Constructor and Description
AbstractWordDocumentTemplatingImpl()

Method Summary

Modifier and Type	Method and Description
boolean	getDataMergeEnabled()
java.lang.String	getDataMergeTemplatePath()
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
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
void	setDataMergeEnabled(boolean dataMergeEnabled)
void	setDataMergeTemplatePath(java.lang.String dataMergeTemplatePath)
boolean	templateIdExists(java.lang.String templateName, java.lang.String ticket) checks for the existance of a template in a docbase.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.tsgrp.opencontent.universal.template.IWordDocumentTemplating

getFields, getMergeTemplate, performMerge

Constructor Detail

AbstractWordDocumentTemplatingImpl

public AbstractWordDocumentTemplatingImpl()

Method Detail

getDataMergeEnabled

public boolean getDataMergeEnabled()

setDataMergeEnabled

public void setDataMergeEnabled(boolean dataMergeEnabled)

getDataMergeTemplatePath

public java.lang.String getDataMergeTemplatePath()

setDataMergeTemplatePath

public void setDataMergeTemplatePath(java.lang.String dataMergeTemplatePath)

getMailMergeFields

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

Description copied from interface: IWordDocumentTemplating

Get all mailmerge fields from a docx word document/template

Specified by:

getMailMergeFields in interface IWordDocumentTemplating

Parameters:

ticket - - cookie or parameter

objectId - - docbase object id (documentum or alfresco)

Returns:

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

performMailMergeAndReturnWordDocument

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

Description copied from interface: IWordDocumentTemplating

performs a mailmerge and returns the completed word document

Specified by:

performMailMergeAndReturnWordDocument in interface IWordDocumentTemplating

Parameters:

ticket - - cookie or parameter

objectId - - object Id of the template

fields - - mailmerge keys and their values

Returns:

performMailMerge

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

Description copied from interface: IWordDocumentTemplating

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

Specified by:

performMailMerge in interface IWordDocumentTemplating

Parameters:

ticket - - cookie or parameter

objectId - - docbase object id (documentum or alfresco)

fields - - map of mailmerge keys and their values

Returns:

word doc with mailmerge fields fufilled

templateIdExists

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

Description copied from interface: IWordDocumentTemplating

checks for the existance of a template in a docbase.

Specified by:

templateIdExists in interface IWordDocumentTemplating

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