Package com.logicaldoc.stamp.automation

Class StampTool

java.lang.Object

com.logicaldoc.stamp.automation.StampTool

public class StampTool
extends Object

Class to apply stamps into documents from inside the Automation

Since:

7.5.1

Author:

Marco Meschieri - LogicalDOC

Constructor Summary

Constructors

Constructor	Description
StampTool()

Method Summary

Modifier and Type	Method	Description
void	stamp(com.logicaldoc.core.document.Document doc, Stamp stamp, com.logicaldoc.core.security.User user)	Applies a stamp in the given document in the name of the given user
void	stamp(com.logicaldoc.core.document.Document doc, String stampName, com.logicaldoc.core.security.User user)	Applies a stamp in the given document in the name of the given user
void	stamp(com.logicaldoc.core.document.Document doc, String stampName, String username)	Applies a stamp in the given document in the name of the given user
void	stamp(com.logicaldoc.core.document.Document doc, String stampName, Map<String,Object> parameters, com.logicaldoc.core.security.User user)	Applies a stamp in the given document in the name of the given user
void	stamp(com.logicaldoc.core.document.Document doc, String stampName, Map<String,Object> parameters, String username)	Applies a stamp in the given document in the name of the given user

Methods inherited from class java.lang.Object

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

Constructor Detail

StampTool

public StampTool()

Method Detail

stamp

public void stamp(com.logicaldoc.core.document.Document doc,
                  Stamp stamp,
                  com.logicaldoc.core.security.User user)
           throws Exception

Applies a stamp in the given document in the name of the given user

Parameters:

doc - the document to stamp

stamp - the stamp to apply (use stamp.parameters to pass your dynamic parameters to the stamp automation)

user - the current user

Throws:

Exception - a generic error

stamp

public void stamp(com.logicaldoc.core.document.Document doc,
                  String stampName,
                  Map<String,Object> parameters,
                  com.logicaldoc.core.security.User user)
           throws Exception

Applies a stamp in the given document in the name of the given user

Parameters:

doc - the document to stamp

stampName - name of the stamp to apply

user - the current user

parameters - optional map of parameters to pass to the Stamp automation

Throws:

Exception - a generic error

stamp

public void stamp(com.logicaldoc.core.document.Document doc,
                  String stampName,
                  com.logicaldoc.core.security.User user)
           throws Exception

Applies a stamp in the given document in the name of the given user

Parameters:

doc - the document to stamp

stampName - name of the stamp to apply

user - the current user

Throws:

Exception - a generic error

stamp

public void stamp(com.logicaldoc.core.document.Document doc,
                  String stampName,
                  Map<String,Object> parameters,
                  String username)
           throws Exception

Applies a stamp in the given document in the name of the given user

Parameters:

doc - the document to stamp

stampName - name of the stamp to apply

parameters - optional map of parameters to pass to the Stamp automation

username - the username of the current user

Throws:

Exception - a generic error

stamp

public void stamp(com.logicaldoc.core.document.Document doc,
                  String stampName,
                  String username)
           throws Exception

Applies a stamp in the given document in the name of the given user

Parameters:

doc - the document to stamp

stampName - name of the stamp to apply

username - the username of the current user

Throws:

Exception - a generic error