atg.service.collections.filter.scenario

Class FilterSlot

java.lang.Object

atg.process.action.ActionImpl

atg.service.collections.filter.scenario.FilterSlot

All Implemented Interfaces:

Action

public class FilterSlot
extends ActionImpl

This scenario action provides the ability to filter slot contents.

It is expected that the slot was prefilled prior to this action.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string
protected FilterActionConfiguration	mFilterActionConfiguration The FilterActionConfiguration reference
static java.lang.String	PARAM_FILTER
static java.lang.String	PARAM_KEY
static java.lang.String	PARAM_SLOT

Constructor Summary

Constructors

Constructor and Description
FilterSlot()

Method Summary

Modifier and Type	Method and Description
void	configure(java.lang.Object pConfiguration) The configuration object provides the reference to the configurable filter parameters
protected void	executeAction(ProcessExecutionContext pContext) Executes this action in the given single process execution context.
protected CachedCollectionFilter	getFilter(ProcessExecutionContext pContext) Returns the filter parameter.
protected FilterActionConfiguration	getFilterActionConfiguration()
protected java.lang.String	getKey(ProcessExecutionContext pContext) Returns the key parameter.
protected Slot	getSlot(ProcessExecutionContext pContext) Returns the slot parameter.
void	initialize(java.util.Map pParameters) Called by scenario manager to initialize the action

Methods inherited from class atg.process.action.ActionImpl

execute, execute, getActionName, 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

PARAM_KEY

public static final java.lang.String PARAM_KEY

See Also:

Constant Field Values

PARAM_SLOT

public static final java.lang.String PARAM_SLOT

See Also:

Constant Field Values

PARAM_FILTER

public static final java.lang.String PARAM_FILTER

See Also:

Constant Field Values

mFilterActionConfiguration

protected FilterActionConfiguration mFilterActionConfiguration

The FilterActionConfiguration reference

Constructor Detail

FilterSlot

public FilterSlot()

Method Detail

getFilterActionConfiguration

protected FilterActionConfiguration getFilterActionConfiguration()

configure

public void configure(java.lang.Object pConfiguration)
               throws ProcessException,
                      java.lang.UnsupportedOperationException

The configuration object provides the reference to the configurable filter parameters

Specified by:

configure in interface Action

Overrides:

configure in class ActionImpl

Throws:

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

java.lang.UnsupportedOperationException - if this action is not configurable

See Also:

atg.filter.scenario.FilterActionConfiguration

initialize

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

Called by scenario manager to initialize the action

Specified by:

initialize in interface Action

Overrides:

initialize in class ActionImpl

Throws:

ProcessException - if the action could not be properly initialized - for example, if not all of the required parameters are present in the Map

See Also:

Expression

getKey

protected java.lang.String getKey(ProcessExecutionContext pContext)
                           throws ProcessException

Returns the key parameter. The key param is identified in the parameter map by the key PARAM_KEY

Returns:

String the key

Throws:

ProcessException

getFilter

protected CachedCollectionFilter getFilter(ProcessExecutionContext pContext)
                                    throws ProcessException

Returns the filter parameter. The filter param is identified in the parameter map by the key PARAM_FILTER

Returns:

the filter component

Throws:

ProcessException

getSlot

protected Slot getSlot(ProcessExecutionContext pContext)
                throws ProcessException

Returns the slot parameter. The slot param is identified in the parameter map by the key PARAM_SLOT

Returns:

the slot component

Throws:

ProcessException

executeAction

protected void executeAction(ProcessExecutionContext pContext)
                      throws ProcessException

Description copied from class: ActionImpl

Executes this action in the given single process execution context. Called by both of the execute methods.

Specified by:

executeAction in class ActionImpl

Throws:

ProcessException - if the action can not be executed