info.magnolia.ui.admincentral.shellapp.pulse.task.action

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

java.lang.Object

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

info.magnolia.ui.admincentral.shellapp.pulse.task.action.AbstractTaskAction<D>

Type Parameters:

D - ActionDefinition.

All Implemented Interfaces:

info.magnolia.ui.api.action.Action

Direct Known Subclasses:

ArchiveTaskAction, ClaimTaskAction, RejectTaskAction, ResolveTaskAction, RetryTaskAction

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

Abstract action for a task action.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	ACTOR_ID
protected static String	DECISION
protected static org.slf4j.Logger	log

Constructor Summary

Constructors

Constructor and Description
AbstractTaskAction(D definition, info.magnolia.task.Task task, info.magnolia.task.TasksManager tasksManager, DefaultTaskDetailPresenter taskPresenter, info.magnolia.ui.api.shell.Shell shell)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	canExecuteTask(info.magnolia.task.Task task) Deprecated. since 5.4, use availability rules to check the allowed statuses.
void	execute()
protected abstract void	executeTask(info.magnolia.task.TasksManager tasksManager, info.magnolia.task.Task task) Subclasses need to implement this method to actually execute the task.
protected info.magnolia.ui.api.shell.Shell	getShell() Subclasses can use the shell e.g.
protected DefaultTaskDetailPresenter	getTaskPresenter() Subclasses can use the TaskPresenter to interact back with it and its parent presenter, i.e.

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

log

protected static final org.slf4j.Logger log

DECISION

protected static final String DECISION

See Also:

Constant Field Values

ACTOR_ID

protected static final String ACTOR_ID

See Also:

Constant Field Values

Constructor Detail

AbstractTaskAction

public AbstractTaskAction(D definition,
                  info.magnolia.task.Task task,
                  info.magnolia.task.TasksManager tasksManager,
                  DefaultTaskDetailPresenter taskPresenter,
                  info.magnolia.ui.api.shell.Shell shell)

Method Detail

execute

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

Throws:

info.magnolia.ui.api.action.ActionExecutionException

executeTask

protected abstract void executeTask(info.magnolia.task.TasksManager tasksManager,
               info.magnolia.task.Task task)

Subclasses need to implement this method to actually execute the task.

canExecuteTask

@Deprecated
protected void canExecuteTask(info.magnolia.task.Task task)
                       throws IllegalStateException

Deprecated. since 5.4, use availability rules to check the allowed statuses.

Subclasses can override this method to check if the current task can actually be executed, e.g. by checking the current Task status. Default implementation does nothing.

Throws:

IllegalStateException - if a task status doesn't allow this action to be executed (e.g. trying to complete a task which is not in progress). In general, subclasses can throw this exception for any reason they deem should cause the current task execution to be aborted.

See Also:

info.magnolia.ui.admincentral.shellapp.pulse.task.action.availability.TaskAvailabilityRule}

getShell

protected info.magnolia.ui.api.shell.Shell getShell()

Subclasses can use the shell e.g. to display success notifications.

getTaskPresenter

protected DefaultTaskDetailPresenter getTaskPresenter()

Subclasses can use the TaskPresenter to interact back with it and its parent presenter, i.e. PulsePresenter.