com.axemble.vdoc.sdk.mail.extensions

Class BaseMailExtension

java.lang.Object

com.axemble.vdoc.sdk.mail.extensions.BaseMailExtension

All Implemented Interfaces:

com.axemble.vdoc.mail.extensions.IMailExtensionSupport

public abstract class BaseMailExtension
extends Object
implements com.axemble.vdoc.mail.extensions.IMailExtensionSupport

The BaseMailExtension class provides direct access to the SDK API.

You can access the following methods:

• getPortalModule() : the module to manipulate the back office system;
• getDirectoryModule() : the module to manipulate the directory system;
• getProjectModule() : the module to manipulate the project system;
• getWorkflowModule() : the module to manipulate the workflow system;
• getWorkflowInstance() : the current workflow instance document;
• getTaskInstance() : the current activity of the document;
• getMessage() : the internal MimeMessage.
• getPreviousTaskInstanceOperator() : the operator of the previous task instance.

Version:

1.0, 15/04/2008

Author:

vlygeros

See Also:

IWorkflowModule, IWorkflowInstance, ITaskInstance

Field Summary

Fields

Modifier and Type	Field and Description
protected static com.axemble.vdp.utils.Logger	LOGGER

Constructor Summary

Constructors

Constructor and Description
BaseMailExtension()

Method Summary

Modifier and Type	Method and Description
protected abstract void	afterSend() This method is called just after the mail has been sent.
void	afterSendMail()
protected abstract boolean	beforeSend() This method is called before mail has been submitted
boolean	beforeSendMail()
protected String	getCurrentLanguage() This method return the language of the mail
protected IDirectoryModule	getDirectoryModule()
protected IMailForm	getMailForm()
protected javax.mail.internet.MimeMessage	getMessage()
protected IPortalModule	getPortalModule()
protected IUser	getPreviousTaskInstanceOperator() Returns the operator on the previous task instance
protected IProjectModule	getProjectModule()
protected IResource	getResource()
protected ITaskInstance	getTaskInstance()
protected IWorkflowInstance	getWorkflowInstance()
protected IWorkflowModule	getWorkflowModule()
void	init(com.axemble.vdoc.mail.structures.MailData mailData)
protected String	onFillLanguage() This method is called just before the mail is built.
String	onFillLanguageMail()
void	onFillRecipients(MailRecipients mailRecipients) Add, modify the addresses for the mail recipient
IBlockDefinition	onPrepare()
void	onPrepare(IBlockDefinition blockDefinition)
void	unInit()

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

protected static com.axemble.vdp.utils.Logger LOGGER

Constructor Detail

BaseMailExtension

public BaseMailExtension()

Method Detail

init

public final void init(com.axemble.vdoc.mail.structures.MailData mailData)

getMailForm

protected final IMailForm getMailForm()

unInit

public final void unInit()

afterSendMail

public final void afterSendMail()

beforeSendMail

public final boolean beforeSendMail()

onFillLanguageMail

public final String onFillLanguageMail()

onPrepare

public void onPrepare(IBlockDefinition blockDefinition)

onPrepare

public final IBlockDefinition onPrepare()

getWorkflowModule

protected final IWorkflowModule getWorkflowModule()

Returns:

the workflowModule

getPortalModule

protected final IPortalModule getPortalModule()

Returns:

the portalModule

getDirectoryModule

protected final IDirectoryModule getDirectoryModule()

Returns:

the directoryModule

getProjectModule

protected final IProjectModule getProjectModule()

Returns:

the projectModule

getWorkflowInstance

protected final IWorkflowInstance getWorkflowInstance()

Returns:

the workflowInstance

getResource

protected final IResource getResource()

Returns:

the workflowInstance

getTaskInstance

protected final ITaskInstance getTaskInstance()

Returns:

the taskInstance

getPreviousTaskInstanceOperator

protected final IUser getPreviousTaskInstanceOperator()

Returns the operator on the previous task instance

Returns:

a IUser object

getMessage

protected final javax.mail.internet.MimeMessage getMessage()

Returns:

the MimeMessage object

beforeSend

protected abstract boolean beforeSend()

This method is called before mail has been submitted

Returns:

true if everything went well. Return false is something wrong happened.

afterSend

protected abstract void afterSend()

This method is called just after the mail has been sent. This method notifies you only if the sending process succeeded.

onFillLanguage

protected String onFillLanguage()

This method is called just before the mail is built. Force the language for the mail

onFillRecipients

public void onFillRecipients(MailRecipients mailRecipients)

Add, modify the addresses for the mail recipient

Parameters:

mailRecipients - The structure to manipulate the message recipients.

getCurrentLanguage

protected final String getCurrentLanguage()

This method return the language of the mail