info.magnolia.ui.framework.action

Class DeleteAction<D extends CommandActionDefinition>

java.lang.Object

info.magnolia.ui.api.action.AbstractAction<D>

info.magnolia.ui.framework.action.AbstractMultiItemAction<D>

info.magnolia.ui.framework.action.AbstractCommandAction<D>

info.magnolia.ui.framework.action.DeleteAction<D>

Type Parameters:

D - CommandActionDefinition.

All Implemented Interfaces:

Action

Direct Known Subclasses:

AbstractDeleteGroupOrRoleAction, DeleteEmptyFolderAction, DeleteFolderAction, MarkNodeAsDeletedAction

public class DeleteAction<D extends CommandActionDefinition>
extends AbstractCommandAction<D>

Deletes a node from the repository using the delete command.

Field Summary

Fields

Modifier and Type	Field and Description
protected info.magnolia.event.EventBus	eventBus
protected List<JcrItemAdapter>	items
protected UiContext	uiContext

Fields inherited from class info.magnolia.ui.framework.action.AbstractCommandAction

COMMAND_RESULT, LONG_RUNNING_ACTION_NOTIFICATION, PARALLEL_EXECUTION_NOT_ALLOWED_NOTIFICATION

Constructor Summary

Constructors

Constructor and Description
DeleteAction(D definition, JcrItemAdapter item, info.magnolia.commands.CommandsManager commandsManager, info.magnolia.event.EventBus eventBus, UiContext uiContext, info.magnolia.i18nsystem.SimpleTranslator i18n)
DeleteAction(D definition, List<JcrItemAdapter> items, info.magnolia.commands.CommandsManager commandsManager, info.magnolia.event.EventBus eventBus, UiContext uiContext, info.magnolia.i18nsystem.SimpleTranslator i18n)

Method Summary

Modifier and Type	Method and Description
protected void	executeOnItem(JcrItemAdapter item) Handles the retrieval of the Command instance defined in the CommandActionDefinition associated with this action and then performs the actual command execution.
protected String	getFailureMessage() Returns the message to display, if the execution fails on at least ONE item.
protected info.magnolia.i18nsystem.SimpleTranslator	getI18n()
protected String	getSuccessMessage() Returns the message to display, if the execution succeeds on ALL items.
protected void	onPostExecute() Post Command Execution.
protected void	onPreExecute() Pre Command Execution.

Methods inherited from class info.magnolia.ui.framework.action.AbstractCommandAction

buildParams, getCommand, getCommandsManager, getParams, isInvokeAsynchronously, onError

Methods inherited from class info.magnolia.ui.framework.action.AbstractMultiItemAction

execute, getCurrentItem, getErrorNotification, getFailedItems, getItemComparator, getItems, getSortedItems, getUiContext, setCurrentItem

Methods inherited from class info.magnolia.ui.api.action.AbstractAction

getDefinition

Methods inherited from class java.lang.Object

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

Field Detail

uiContext

protected final UiContext uiContext

items

protected final List<JcrItemAdapter> items

eventBus

protected final info.magnolia.event.EventBus eventBus

Constructor Detail

DeleteAction

public DeleteAction(D definition,
                    JcrItemAdapter item,
                    info.magnolia.commands.CommandsManager commandsManager,
                    @Named(value="admincentral")
                    info.magnolia.event.EventBus eventBus,
                    UiContext uiContext,
                    info.magnolia.i18nsystem.SimpleTranslator i18n)

DeleteAction

public DeleteAction(D definition,
                    List<JcrItemAdapter> items,
                    info.magnolia.commands.CommandsManager commandsManager,
                    @Named(value="admincentral")
                    info.magnolia.event.EventBus eventBus,
                    UiContext uiContext,
                    info.magnolia.i18nsystem.SimpleTranslator i18n)

Method Detail

onPreExecute

protected void onPreExecute()
                     throws Exception

Description copied from class: AbstractCommandAction

Pre Command Execution. Class that implement CommansActionBase should use this in order to perform pre Command Tasks. When overriding make sure to call super to build the parameter map.

Overrides:

onPreExecute in class AbstractCommandAction<D extends CommandActionDefinition>

Throws:

Exception

onPostExecute

protected void onPostExecute()
                      throws Exception

Description copied from class: AbstractCommandAction

Post Command Execution. Class that implement CommansActionBase should use this in order to perform post Command Tasks.

Overrides:

onPostExecute in class AbstractCommandAction<D extends CommandActionDefinition>

Throws:

Exception

executeOnItem

protected void executeOnItem(JcrItemAdapter item)
                      throws ActionExecutionException

Description copied from class: AbstractCommandAction

Handles the retrieval of the Command instance defined in the CommandActionDefinition associated with this action and then performs the actual command execution.

Overrides:

executeOnItem in class AbstractCommandAction<D extends CommandActionDefinition>

Throws:

ActionExecutionException - if no command is found or if command execution throws an exception.

getSuccessMessage

protected String getSuccessMessage()

Description copied from class: AbstractMultiItemAction

Returns the message to display, if the execution succeeds on ALL items. May return null, if the implementing action handles the user notification on its own.

Overrides:

getSuccessMessage in class AbstractCommandAction<D extends CommandActionDefinition>

getFailureMessage

protected String getFailureMessage()

Description copied from class: AbstractMultiItemAction

Returns the message to display, if the execution fails on at least ONE item. May return null, if the implementing action handles the user notification on its own.

Overrides:

getFailureMessage in class AbstractCommandAction<D extends CommandActionDefinition>

getI18n

protected info.magnolia.i18nsystem.SimpleTranslator getI18n()

Overrides:

getI18n in class AbstractCommandAction<D extends CommandActionDefinition>