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

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

All Implemented Interfaces:

com.opensymphony.workflow.FunctionProvider

public class RoleAddressProvider
extends UsersAddressProvider

This function is used when an email should be sent to all members of a role.

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

RoleAddressProvider()
Default constructor.

Method Summary

protected java.util.Collection	getPrincipals() Returns the principals that should be the recipients of the email.
protected void	initialize() Method used for initializing the function; will be called before execute is called.

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

populate

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

addRecipient, execute

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

RoleAddressProvider

public RoleAddressProvider()

Default constructor.

Method Detail

getPrincipals

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

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

Specified by:

getPrincipals in class UsersAddressProvider

Returns:

a Collection of InfogluePrincipal:s.

Throws:

com.opensymphony.workflow.WorkflowException

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 AddressProvider

Throws:

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