de.hybris.platform.hmc.util.action

Class RemoveAction

java.lang.Object

de.hybris.platform.hmc.util.action.RemoveAction

All Implemented Interfaces:

HMCAction, Serializable

Direct Known Subclasses:

GenericItemRemoveAction

public abstract class RemoveAction
extends Object
implements HMCAction

Abstract super class for all actions which will be called if a item removing task was initiated via the hmc.

Since:

2.10

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	DISPLAY_STATE action parameter - the displayState
static String	INITIAL_VALUES action parameter - the list of initial values
static String	ITEM action parameter - the item to be removed
static String	ITEM_TYPE action parameter - the type of the item to be removed
protected static Logger	LOG

Constructor Summary

Constructors

Constructor and Description
RemoveAction()

Method Summary

Modifier and Type	Method and Description
protected abstract ActionResult	afterRemove(ComposedType itemType, DisplayState displayState, Map values, ActionResult actionResult)
protected abstract ActionResult	beforeRemove(Item item, ComposedType itemType, DisplayState displayState, Map values)
AbstractActionDialogChip	createDialogChip(Chip parent, AbstractActionChip actionChip)
String	getConfirmationMessage() This default implementation returns null (It means the standard confirmation message will be used if confirmation is on).
boolean	hasDialogChip(AbstractActionChip actionChip)
boolean	needConfirmation() This default implementation returns false.
ActionResult	perform(ActionEvent actionEvent) This action requires Map with action parameters in ActionEvent data.
protected abstract ActionResult	remove(Item item, DisplayState displayState, ActionResult actionResult)

Methods inherited from class java.lang.Object

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

Field Detail

ITEM

public static final String ITEM

action parameter - the item to be removed

See Also:

Constant Field Values

ITEM_TYPE

public static final String ITEM_TYPE

action parameter - the type of the item to be removed

See Also:

Constant Field Values

DISPLAY_STATE

public static final String DISPLAY_STATE

action parameter - the displayState

See Also:

Constant Field Values

INITIAL_VALUES

public static final String INITIAL_VALUES

action parameter - the list of initial values

See Also:

Constant Field Values

LOG

protected static final Logger LOG

Constructor Detail

RemoveAction

public RemoveAction()

Method Detail

beforeRemove

protected abstract ActionResult beforeRemove(Item item,
                                             ComposedType itemType,
                                             DisplayState displayState,
                                             Map values)

Parameters:

item - the Item which should be removed

displayState - DisplayState

values - Map containing all attribute values. (Mapping: AttributeQualifier -> Value) Note: AttributeQualifier should always be treated case insensitive. Use de.hybris.platform.util.collections.CaseInsensitiveMap or other case insensitive implementations.

Returns:

ActionResult with processing informations ( action processed successful etc )

remove

protected abstract ActionResult remove(Item item,
                                       DisplayState displayState,
                                       ActionResult actionResult)

Parameters:

item - the Item which should be removed

displayState - DisplayState

actionResult - The ActionResult object, containing the status of the current action.

Returns:

ActionResult with processing informations ( action processed successful etc )

afterRemove

protected abstract ActionResult afterRemove(ComposedType itemType,
                                            DisplayState displayState,
                                            Map values,
                                            ActionResult actionResult)

Parameters:

itemType - the ComposedType of the removed Item

displayState - DisplayState

values - Map containing all attribute values. (Mapping: AttributeQualifier -> Value) Note: AttributeQualifier should always be treated caseinsensitive. Use de.hybris.platform.util.collections.CaseInsensitiveMap or other caseinsensitive implementations.

actionResult - The ActionResult object, containing the status of the current action.

Returns:

ActionResult with processing informations ( action processed successful etc )

perform

public ActionResult perform(ActionEvent actionEvent)
                     throws JaloBusinessException

This action requires Map with action parameters in ActionEvent data.

Specified by:

perform in interface HMCAction

Parameters:

actionEvent -

Returns:

actionresult containing informations about the action's outcome

Throws:

JaloBusinessException

See Also:

ITEM_TYPE, DISPLAY_STATE

needConfirmation

public boolean needConfirmation()

This default implementation returns false. Overwrite this method if you want confirmation for this action.

Specified by:

needConfirmation in interface HMCAction

getConfirmationMessage

public String getConfirmationMessage()

This default implementation returns null (It means the standard confirmation message will be used if confirmation is on). Overwrite this method if you want yopur own confirmation message for this action.

Specified by:

getConfirmationMessage in interface HMCAction

hasDialogChip

public boolean hasDialogChip(AbstractActionChip actionChip)

Specified by:

hasDialogChip in interface HMCAction

createDialogChip

public AbstractActionDialogChip createDialogChip(Chip parent,
                                                 AbstractActionChip actionChip)

Specified by:

createDialogChip in interface HMCAction