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

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
              org.infoglue.cms.applications.workflowtool.function.email.UsersAddressProvider

All Implemented Interfaces:

com.opensymphony.workflow.FunctionProvider

Direct Known Subclasses:

GroupAddressProvider, RoleAddressProvider

public abstract class UsersAddressProvider
extends AddressProvider

This function is used when an email should be sent to a number of SystemUser:s.

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

UsersAddressProvider()
Default constructor.

Method Summary

protected abstract java.util.Collection	getPrincipals() Returns the principals that should be the recipients of the email.
protected void	populate() Add all recipients.

Methods inherited from class org.infoglue.cms.applications.workflowtool.function.email.AddressProvider

addRecipient, execute, initialize

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

UsersAddressProvider

public UsersAddressProvider()

Default constructor.

Method Detail

getPrincipals

protected abstract java.util.Collection getPrincipals()
                                               throws com.opensymphony.workflow.WorkflowException

Returns the principals that should be the recipients of the email.

Returns:

a Collection of InfogluePrincipal:s.

Throws:

com.opensymphony.workflow.WorkflowException

populate

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

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

Specified by:

populate in class AddressProvider

Throws:

com.opensymphony.workflow.WorkflowException