com.tsgrp.opencontent.wizard.core.esig

Interface ISignaturePage

All Known Implementing Classes:

TSGAbstractAppendSignaturePageImpl, TSGAlfrescoAppendSignaturePageImpl, TSGDctmAppendSignaturePageImpl, TSGDynamoAppendSignaturePageImpl, TSGHBaseAppendSignaturePageImpl

public interface ISignaturePage

Interface containing basic ISignature methods.

Method Summary

Modifier and Type	Method and Description
boolean	appendSignaturePages(java.lang.String ticket, java.lang.String objectId, ApprovalDetails approvalDetails) Appends signature page to a document.
void	cacheUserBean(java.lang.String ticket, SignatureEvent se, java.util.Map<java.lang.String,java.lang.Object> userBeanCache) This method caches the user bean associated with the formSignature event or does nothing if this user bean already exists
boolean	createSignaturePage(java.lang.String ticket, java.lang.String objectId, java.util.List<SignatureEvent> signatures, EnhancedCompleteObject eco, java.util.Map<java.lang.String,java.lang.Object> userBeanCache) Create a signature page pdf of the workflow doc or form doc

Method Detail

appendSignaturePages

boolean appendSignaturePages(java.lang.String ticket,
                             java.lang.String objectId,
                             ApprovalDetails approvalDetails)

Appends signature page to a document. This interface leaves it to the implementation to retrieve the signature details for the object.

Parameters:

ticket - - OpenContent ticket

psiId - - string of psiId Id

approvalDetails - - Approval Details object containing information regarding signatures

Returns:

true or false, indicating whether or not the signature page was applied. False should be treated as an error and logged.

createSignaturePage

boolean createSignaturePage(java.lang.String ticket,
                            java.lang.String objectId,
                            java.util.List<SignatureEvent> signatures,
                            EnhancedCompleteObject eco,
                            java.util.Map<java.lang.String,java.lang.Object> userBeanCache)

Create a signature page pdf of the workflow doc or form doc

Parameters:

ticket -

objectId - - id of the form or wfdoc

signatures - - The signatures used to create page

templateLocation - - The location of the template to use

formOrDoc - - EnhancedCompleteObject

cacheUserBean

void cacheUserBean(java.lang.String ticket,
                   SignatureEvent se,
                   java.util.Map<java.lang.String,java.lang.Object> userBeanCache)

This method caches the user bean associated with the formSignature event or does nothing if this user bean already exists

Parameters:

ticket -

formSignature -

userBeanCache - - reference to the single user bean cache that is passed around in TSGAppendSignaturePageImpl