info.magnolia.cache.browser.app.action

Class AbstractMultiItemAction<D extends info.magnolia.ui.api.action.ActionDefinition>

java.lang.Object

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

info.magnolia.cache.browser.app.action.AbstractMultiItemAction<D>

Type Parameters:

D - Definition

All Implemented Interfaces:

info.magnolia.ui.api.action.Action

Direct Known Subclasses:

DeleteCacheEntryAction, DownloadCacheContentAction

public abstract class AbstractMultiItemAction<D extends info.magnolia.ui.api.action.ActionDefinition>
extends info.magnolia.ui.api.action.AbstractAction<D>

Base class that can work over multiple Items.

Constructor Summary

Constructors

Constructor and Description
AbstractMultiItemAction(D definition, com.vaadin.data.Item relatedItem, info.magnolia.ui.api.context.UiContext uiContext, info.magnolia.i18nsystem.SimpleTranslator i18n)
AbstractMultiItemAction(D definition, List<com.vaadin.data.Item> relatedItems, info.magnolia.ui.api.context.UiContext uiContext, info.magnolia.i18nsystem.SimpleTranslator i18n)

Method Summary

Methods

Modifier and Type	Method and Description
void	execute()
protected abstract void	executeOnItem(com.vaadin.data.Item item)
protected String	formatFailedItemsForMessage(Map<com.vaadin.data.Item,String> failedItems)
D	getDefinition()
protected abstract String	getFailureMessageKey()
List<com.vaadin.data.Item>	getItems()
protected abstract String	getSuccessMessageKey()
info.magnolia.i18nsystem.SimpleTranslator	getTranslator()
info.magnolia.ui.api.context.UiContext	getUiContext()
protected abstract String	itemToString(com.vaadin.data.Item item)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractMultiItemAction

public AbstractMultiItemAction(D definition,
                       com.vaadin.data.Item relatedItem,
                       info.magnolia.ui.api.context.UiContext uiContext,
                       info.magnolia.i18nsystem.SimpleTranslator i18n)

AbstractMultiItemAction

public AbstractMultiItemAction(D definition,
                       List<com.vaadin.data.Item> relatedItems,
                       info.magnolia.ui.api.context.UiContext uiContext,
                       info.magnolia.i18nsystem.SimpleTranslator i18n)

Method Detail

execute

public void execute()
             throws info.magnolia.ui.api.action.ActionExecutionException

Throws:

info.magnolia.ui.api.action.ActionExecutionException

executeOnItem

protected abstract void executeOnItem(com.vaadin.data.Item item)
                               throws Exception

Throws:

Exception

getSuccessMessageKey

protected abstract String getSuccessMessageKey()

getFailureMessageKey

protected abstract String getFailureMessageKey()

itemToString

protected abstract String itemToString(com.vaadin.data.Item item)

formatFailedItemsForMessage

protected String formatFailedItemsForMessage(Map<com.vaadin.data.Item,String> failedItems)

getDefinition

public D getDefinition()

Overrides:

getDefinition in class info.magnolia.ui.api.action.AbstractAction<D extends info.magnolia.ui.api.action.ActionDefinition>

getItems

public List<com.vaadin.data.Item> getItems()

getUiContext

public info.magnolia.ui.api.context.UiContext getUiContext()

getTranslator

public info.magnolia.i18nsystem.SimpleTranslator getTranslator()