ItemAction (hybris Commerce Suite 6.3.0.0-SNAPSHOT)

java.lang.Object
- de.hybris.platform.hmc.util.action.ItemAction

All Implemented Interfaces:

HMCAction, HMCStatefulAction, Serializable

Direct Known Subclasses:

AbortCronJobAction, AbortCurrentStepAction, AbstractCalculationAction, AcceptDifferencesAction, B2BItemAction, CompleteWorkflowAction, CreateChapterPreviewAction, CreatePagePreviewAction, CreatePublicationPreviewAction, CreateWorkflowAction, DataloaderInitialLoadItemAction, DeleteConvertedMediasAction, DeleteJobLogAction, DeleteMetaDataAction, DontAcceptDifferencesAction, ExportCometConfigurationAction, ExportScriptSaveAction, ExportScriptValidateAction, ExportSolrConfigurationAction, ExportStopWordsAction, ExportSynonymsAction, ExtractMetaDataAction, GeneratePromotionVoucherCodeAction, GeoCodePOSAction, ItemCopyAction, MediaConversionAction, MoveMediaItemAction, OpenPublicationAction, OpenTableEditorAction, OrderCartCalculateWithPromotionsAction, PerformCronJobAction, PreviewCatalogVersionItemAction, RebuildIndexAction, RejectWorkflowAction, ReloadValidationAction, RemoveCatalogWizardAction, RemoveMobileMessageAction, RepairProcessAction, ReSendMobileMessageAction, ScriptGeneratorAction, StartSyncAction, SynchronizeCatalogVersionWizardAction, SyncItemAction, TestLDAPConfigurationAction, UndoCronJobAction, UpdateEnginesAction, UpdateIndexAction, WorkflowActionDecide
```
public abstract class ItemAction
extends Object
implements HMCStatefulAction
```
Extend this class to implement an item action.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

ItemAction()

Constructors
Constructor and Description
`ItemAction()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected boolean`	`canChange(Item item)` Returns `true` if the current user can modify the given item.
`protected boolean`	`canRead(Item item)` Returns `true` if the current user can read the given item.
`protected boolean`	`canRemove(Item item)` Returns `true` if the current user can remove the given item.
`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).
`protected ItemEditorContext`	`getEditorContext(ActionEvent actionEvent)`
`protected HMCContext`	`getHMCContext(ActionEvent actionEvent)`
`protected Item`	`getItem(ActionEvent actionEvent)` Reads the item form the ActionEvent.
`protected Map`	`getNodeParams()`
`boolean`	`hasDialogChip(AbstractActionChip actionChip)`
`void`	`initialize(ItemActionNode node)`
`boolean`	`isActive(ActionEvent event)`
`boolean`	`isAutoSave()` Returns true if auto save is enabled.
`boolean`	`isVisible(ActionEvent actionEvent)`
`boolean`	`needConfirmation()` This default implementation returns `false`.
`boolean`	`needSaveBeforePerform()` The item will be saved before performing action if this option is set to `true`.
`abstract ActionResult`	`perform(ActionEvent actionEvent)` This action requires the Item in ActionEvent data.
`void`	`setAutoSave(boolean autoSave)` Enables auto saving, see `isAutoSave()`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ItemAction
```
public ItemAction()
```
- Method Detail
  - initialize
```
public final void initialize(ItemActionNode node)
```
  - getNodeParams
```
protected Map getNodeParams()
```
  - getHMCContext
```
protected HMCContext getHMCContext(ActionEvent actionEvent)
```
  - perform
```
public abstract ActionResult perform(ActionEvent actionEvent)
                              throws JaloBusinessException
```
    This action requires the Item in ActionEvent data.
    
    Specified by:
    
    perform in interface HMCAction
    
    Parameters:
    
    actionEvent -
    
    Returns:
    
    actionresult containing informations about the action's outcome
    
    Throws:
    
    JaloBusinessException
  - 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
  - needSaveBeforePerform
```
public boolean needSaveBeforePerform()
```
    The item will be saved before performing action if this option is set to true. This default implementation returns true.
  - getItem
```
protected Item getItem(ActionEvent actionEvent)
```
    Reads the item form the ActionEvent.
    
    Parameters:
    
    actionEvent -
    
    Returns:
    
    Item
  - getEditorContext
```
protected ItemEditorContext getEditorContext(ActionEvent actionEvent)
```
  - canRead
```
protected boolean canRead(Item item)
```
    Returns true if the current user can read the given item.
    
    Parameters:
    
    item - Item to check the read right for
    
    Returns:
    
    true if the current user can read the given item, false otherwise
  - canChange
```
protected boolean canChange(Item item)
```
    Returns true if the current user can modify the given item.
    
    Parameters:
    
    item - Item to check the modify right for
    
    Returns:
    
    true if the current user can modify the given item, false otherwise
  - canRemove
```
protected boolean canRemove(Item item)
```
    Returns true if the current user can remove the given item.
    
    Parameters:
    
    item - Item to check the remove right for
    
    Returns:
    
    true if the current user can remove the given item, false otherwise
  - isActive
```
public boolean isActive(ActionEvent event)
```
    Specified by:
    
    isActive in interface HMCStatefulAction
    
    Returns:
    
    true if the action can be performed
  - isVisible
```
public boolean isVisible(ActionEvent actionEvent)
```
    Specified by:
    
    isVisible in interface HMCStatefulAction
  - isAutoSave
```
public boolean isAutoSave()
```
    Returns true if auto save is enabled. This should signalize that this action can generally be enabled even when the item is not created yet. In such a situation the item will be saved immediately before the action is processed (the action will only be started if saving was successful, of course).
    
    Returns:
    
    true if auto save is enabled.
  - setAutoSave
```
public void setAutoSave(boolean autoSave)
```
    Enables auto saving, see isAutoSave().
    
    Parameters:
    
    autoSave - true to enable auto saving, default is false.
  - 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

Class ItemAction

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ItemAction

Method Detail

initialize

getNodeParams

getHMCContext

perform

needConfirmation

getConfirmationMessage

needSaveBeforePerform

getItem

getEditorContext

canRead

canChange

canRemove

isActive

isVisible

isAutoSave

setAutoSave

hasDialogChip

createDialogChip