atg.projects.store.scenario.action
Class GenerateEmailList

java.lang.Object
  atg.process.action.ActionImpl
      atg.projects.store.scenario.action.GenerateEmailList

All Implemented Interfaces:

atg.process.action.Action

public class GenerateEmailList
extends atg.process.action.ActionImpl

Custom action to generate a list of emails for targeted email campaigns.

Field Summary

static java.lang.String

CLASS_VERSION Class version string.

Constructor Summary

GenerateEmailList()

Method Summary

void	configure(java.lang.Object pConfiguration) Configures the action using the given configuration object.
void	execute(atg.process.ProcessExecutionContext pContext) Executes the action in the given process execution context.
void	execute(atg.process.ProcessExecutionContext[] pContexts) Executes the action in each of the given process execution contexts.
protected void	executeAction(atg.process.ProcessExecutionContext pContext) Override OOTB method so we can set the file name.
java.lang.String	getActionName() Returns the name of the action.
java.lang.String	getFileName() Retrieves the name of the output file.
EmailListWriter	getWriter() Retrieves the e-mail list writer component.
void	initialize(java.util.Map pParameters) Override OOTB method so we can store our required parameters.
void	setFileName(java.lang.String pFileName) Sets the name of the output file..
void	setWriter(EmailListWriter pWriter) Sets the e-mail list writer component.

Methods inherited from class atg.process.action.ActionImpl

getParameterExpression, getParameterValue, storeOptionalParameter, storeRequiredMutableParameter, storeRequiredParameter, toString, toString

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string.

Constructor Detail

GenerateEmailList

public GenerateEmailList()

Method Detail

setFileName

public void setFileName(java.lang.String pFileName)

Sets the name of the output file..

Parameters:

pFileName - - file name of output file.

getFileName

public java.lang.String getFileName()

Retrieves the name of the output file.

Returns:

output file name.

getActionName

public java.lang.String getActionName()

Returns the name of the action.

Overrides:

getActionName in class atg.process.action.ActionImpl

Returns:

the action name.

getWriter

public EmailListWriter getWriter()

Retrieves the e-mail list writer component.

Returns:

the writer.

setWriter

public void setWriter(EmailListWriter pWriter)

Sets the e-mail list writer component.

Parameters:

pWriter - - the writer to set.

configure

public void configure(java.lang.Object pConfiguration)
               throws atg.process.ProcessException

Configures the action using the given configuration object. The configuration object is typically a global Nucleus component which is configured with the information necessary for the action's operation.

Specified by:

configure in interface atg.process.action.Action

Overrides:

configure in class atg.process.action.ActionImpl

Parameters:

pConfiguration - - configuration

Throws:

atg.process.ProcessException - if the action could not be configured - for example, because some of the required properties are missing from the configuration

initialize

public void initialize(java.util.Map pParameters)
                throws atg.process.ProcessException

Override OOTB method so we can store our required parameters.

Specified by:

initialize in interface atg.process.action.Action

Overrides:

initialize in class atg.process.action.ActionImpl

Parameters:

pParameters - - parameters

Throws:

atg.process.ProcessException - If the initialization could not be performed - for example, because some of the required parameters are missing

See Also:

Action.initialize(java.util.Map)

executeAction

protected void executeAction(atg.process.ProcessExecutionContext pContext)
                      throws atg.process.ProcessException

Override OOTB method so we can set the file name.

Specified by:

executeAction in class atg.process.action.ActionImpl

Parameters:

pContext - - process execution context

Throws:

atg.process.ProcessException - If the action could not be performed - for example, because some of the required parameters are missing

See Also:

ActionImpl.executeAction(atg.process.ProcessExecutionContext)

execute

public void execute(atg.process.ProcessExecutionContext pContext)
             throws atg.process.action.ActionException

Executes the action in the given process execution context. The context can be used to evaluate any parameter Expressions.

Specified by:

execute in interface atg.process.action.Action

Overrides:

execute in class atg.process.action.ActionImpl

Parameters:

pContext - - process execution context

Throws:

atg.process.action.ActionException - if the action failed when executed in the given context

execute

public void execute(atg.process.ProcessExecutionContext[] pContexts)
             throws atg.process.action.ActionException

Executes the action in each of the given process execution contexts. Each context can be used to evaluate any parameter Expressions.

Specified by:

execute in interface atg.process.action.Action

Overrides:

execute in class atg.process.action.ActionImpl

Parameters:

pContexts - if the action

Throws:

atg.process.action.ActionException - if the action failed when executed in any of the given contexts