de.hybris.platform.hmc.util.action

Class SaveAction

java.lang.Object

de.hybris.platform.hmc.util.action.SaveAction

All Implemented Interfaces:

HMCAction, Serializable

Direct Known Subclasses:

GenericItemSaveAction

public abstract class SaveAction
extends Object
implements HMCAction

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

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	CURRENT_VALUES action parameter - the list of current values
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 saved
protected static Logger	LOG
static String	SPECIAL_EDITORS action parameter - the list of special editors

Constructor Summary

Constructors

Constructor and Description
SaveAction()

Method Summary

Modifier and Type	Method and Description
protected abstract ActionResult	afterSave(Item item, DisplayState displayState, Map currentValues, ActionResult actionResult)
protected abstract ActionResult	afterSave(Item item, DisplayState displayState, Map currentValues, Map initialValues, ActionResult actionResult)
protected abstract ActionResult	beforeSave(Item item, DisplayState displayState, Map currentValues, Map initialValues) The maps currentValues and initialValues can be used to implement filtering of values, which must not be saved.
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	save(Item item, DisplayState displayState, Map currentValues, Map specialEditors, ActionResult actionResult)
protected abstract ActionResult	save(Item item, DisplayState displayState, Map currentValues, Map initialValues, Map specialEditors, ActionResult actionResult)
protected ActionResult	validateSpecialEditors(Item item, DisplayState dispalyState, Map specialEditors, ActionResult result) Validates special editors implementing SpecialValidatingChip to allow them to abort item save process or simply report errors.

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 saved

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

CURRENT_VALUES

public static final String CURRENT_VALUES

action parameter - the list of current values

See Also:

Constant Field Values

SPECIAL_EDITORS

public static final String SPECIAL_EDITORS

action parameter - the list of special editors

See Also:

Constant Field Values

LOG

protected static final Logger LOG

Constructor Detail

SaveAction

public SaveAction()

Method Detail

beforeSave

protected abstract ActionResult beforeSave(Item item,
                                           DisplayState displayState,
                                           Map currentValues,
                                           Map initialValues)

The maps currentValues and initialValues can be used to implement filtering of values, which must not be saved.

Parameters:

item - Item which attributes should be saved.

displayState - DisplayState

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

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

Returns:

ActionResult with processing informations ( action processed successful etc )

validateSpecialEditors

protected ActionResult validateSpecialEditors(Item item,
                                              DisplayState dispalyState,
                                              Map specialEditors,
                                              ActionResult result)

Validates special editors implementing SpecialValidatingChip to allow them to abort item save process or simply report errors.

Parameters:

item - item which is currently being edited

dispalyState - the display state

specialEditors - all special editors as { String, AbstractChip } map

Returns:

ActionResult with processing informations ( action processed successful etc )

save

protected abstract ActionResult save(Item item,
                                     DisplayState displayState,
                                     Map currentValues,
                                     Map specialEditors,
                                     ActionResult actionResult)

Parameters:

item - Item which attributes should be saved.

displayState - DisplayState

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

specialEditors - Map containing all chips, which values are not save through the generic save process.

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

Returns:

ActionResult with processing informations ( action processed successful etc )

save

protected abstract ActionResult save(Item item,
                                     DisplayState displayState,
                                     Map currentValues,
                                     Map initialValues,
                                     Map specialEditors,
                                     ActionResult actionResult)

afterSave

protected abstract ActionResult afterSave(Item item,
                                          DisplayState displayState,
                                          Map currentValues,
                                          ActionResult actionResult)

Parameters:

item - Item which attributes should be saved.

displayState - DisplayState

currentValues - Map containing all attribute values which have been saved. (Mapping: AttributeQualifier -> Value) Note: AttributeQualifier should always be treated case insensitively. 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 )

afterSave

protected abstract ActionResult afterSave(Item item,
                                          DisplayState displayState,
                                          Map currentValues,
                                          Map initialValues,
                                          ActionResult actionResult)

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:

action result containing informations about the action's outcome

Throws:

JaloBusinessException

See Also:

ITEM, DISPLAY_STATE, INITIAL_VALUES, CURRENT_VALUES, SPECIAL_EDITORS

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 your own confirmation message for this action.

Specified by:

getConfirmationMessage in interface HMCAction

hasDialogChip

public boolean hasDialogChip(AbstractActionChip actionChip)

Specified by:

hasDialogChip in interface HMCAction

Since:

2.10

createDialogChip

public AbstractActionDialogChip createDialogChip(Chip parent,
                                                 AbstractActionChip actionChip)

Specified by:

createDialogChip in interface HMCAction

Since:

2.10