de.hybris.platform.hmc.util.action

Class CreateAction

java.lang.Object

de.hybris.platform.hmc.util.action.CreateAction

All Implemented Interfaces:

HMCAction, Serializable

Direct Known Subclasses:

GenericItemCreateAction

public abstract class CreateAction
extends Object
implements HMCAction

Abstract super class for all actions which will be called if a item creation 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_TYPE action parameter - the type of the item to be created
protected static Logger	log

Constructor Summary

Constructors

Constructor and Description
CreateAction()

Method Summary

Modifier and Type	Method and Description
protected abstract ActionResult	afterCreate(Item item, DisplayState displayState, Map initialValues, Map currentValues, ActionResult actionResult)
protected abstract ActionResult	beforeCreate(ComposedType itemType, DisplayState displayState, Map initialValues, Map currentValues) The maps currentValues and initialValues can be used to implement filtering of values, which must not be saved.
protected abstract ActionResult	create(ComposedType itemType, DisplayState displayState, Map initialValues, Map currentValues, ActionResult actionResult)
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.

Methods inherited from class java.lang.Object

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

Field Detail

ITEM_TYPE

public static final String ITEM_TYPE

action parameter - the type of the item to be created

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

log

protected static final Logger log

Constructor Detail

CreateAction

public CreateAction()

Method Detail

beforeCreate

protected abstract ActionResult beforeCreate(ComposedType itemType,
                                             DisplayState displayState,
                                             Map initialValues,
                                             Map currentValues)

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

Parameters:

itemType - A new Item of this ComposedType will be created.

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 )

create

protected abstract ActionResult create(ComposedType itemType,
                                       DisplayState displayState,
                                       Map initialValues,
                                       Map currentValues,
                                       ActionResult actionResult)

Parameters:

itemType - A new Item of this ComposedType will be created.

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.

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

Returns:

ActionResult with processing informations ( action processed successful etc )

afterCreate

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

Parameters:

item - the new created item

displayState - DisplayState

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.

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.

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, INITIAL_VALUES, CURRENT_VALUES

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

Since:

2.10

createDialogChip

public AbstractActionDialogChip createDialogChip(Chip parent,
                                                 AbstractActionChip actionChip)

Specified by:

createDialogChip in interface HMCAction

Since:

2.10