org.infoglue.cms.applications.workflowtool.function.email
Class AddressProvider

java.lang.Object
  org.infoglue.cms.applications.workflowtool.util.InfoglueWorkflowBase
      org.infoglue.cms.applications.workflowtool.function.InfoglueFunction
          org.infoglue.cms.applications.workflowtool.function.email.AddressProvider

All Implemented Interfaces:

com.opensymphony.workflow.FunctionProvider

Direct Known Subclasses:

ContentVersionAddressProvider, UsersAddressProvider

public abstract class AddressProvider
extends InfoglueFunction

Field Summary

Fields inherited from class org.infoglue.cms.applications.workflowtool.function.InfoglueFunction

LOCALE_PARAMETER, PRINCIPAL_PARAMETER

Fields inherited from class org.infoglue.cms.applications.workflowtool.util.InfoglueWorkflowBase

ERROR_PROPERTYSET_PREFIX, FUNCTION_STATUS_PROPERTYSET_KEY, UTF8_ENCODING, WORKFLOW_PROPERTYSET_PREFIX

Constructor Summary

AddressProvider()
Default constructor.

Method Summary

protected void	addRecipient(java.lang.String email)
protected void	execute() Executes this function.
protected void	initialize() Method used for initializing the function; will be called before execute is called.
protected abstract void	populate() Add all recipients.

Methods inherited from class org.infoglue.cms.applications.workflowtool.function.InfoglueFunction

execute, getLocale, getPrincipal, getRequestParameter, setFunctionStatus

Methods inherited from class org.infoglue.cms.applications.workflowtool.util.InfoglueWorkflowBase

argumentExists, getArgument, getArgument, getDatabase, getParameter, getParameter, getParameter, getParameters, getPropertySet, getPropertySetDataString, getPropertySetString, getVariableFromMaps, parameterExists, propertySetContains, removeFromPropertySet, removeFromPropertySet, setParameter, setPropertySetDataString, setPropertySetString, storeContext, throwException, throwException, translate, translateVariables

Methods inherited from class java.lang.Object

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

Constructor Detail

AddressProvider

public AddressProvider()

Default constructor.

Method Detail

populate

protected abstract void populate()
                          throws com.opensymphony.workflow.WorkflowException

Add all recipients. Note that empty email-addresses will be discarded if the required attribute is false.

Throws:

com.opensymphony.workflow.WorkflowException

execute

protected final void execute()
                      throws com.opensymphony.workflow.WorkflowException

Description copied from class: InfoglueFunction

Executes this function.

Specified by:

execute in class InfoglueFunction

Throws:

com.opensymphony.workflow.WorkflowException - if an error occurs during the execution.

addRecipient

protected final void addRecipient(java.lang.String email)

initialize

protected void initialize()
                   throws com.opensymphony.workflow.WorkflowException

Method used for initializing the function; will be called before execute is called.

Note! You must call super.initialize() first.

Overrides:

initialize in class InfoglueFunction

Throws:

com.opensymphony.workflow.WorkflowException - if an error occurs during the initialization.