de.hybris.platform.cronjob.hmc

Class AbortCronJobAction

java.lang.Object

de.hybris.platform.hmc.util.action.ItemAction

de.hybris.platform.cronjob.hmc.AbortCronJobAction

All Implemented Interfaces:

HMCAction, HMCStatefulAction, Serializable

public class AbortCronJobAction
extends ItemAction

HMC item action which can be added to CronJob editors to be able to abort running Cronjobs. Add the following tag (as subtag of either the <td> or the <listlayout> tag) to your hmc.tmpl to add the abort action:

 <action type="item" 
         classname="de.hybris.platform.hmc.ext.cronjob.AbortCronJobAction"
         name="action.abortcronjob"/>
 

The action is used in the hmc.tmpl of the CronJobExtension (<CronJobExtension-Directory>/hmc/resources/hmc.tmpl), just search for 'de.hybris.platform.hmc.ext.cronjob.AbortCronJobAction' to find the definition.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_WAIT

Constructor Summary

Constructors

Constructor and Description
AbortCronJobAction()

Method Summary

Modifier and Type	Method and Description
boolean	isActive(ActionEvent event) Returns true, if the action is active.
ActionResult	perform(ActionEvent event) Tries to abort the CronJob, which is passed as part of the ActionEvent.

Methods inherited from class de.hybris.platform.hmc.util.action.ItemAction

canChange, canRead, canRemove, createDialogChip, getConfirmationMessage, getEditorContext, getHMCContext, getItem, getNodeParams, hasDialogChip, initialize, isAutoSave, isVisible, needConfirmation, needSaveBeforePerform, setAutoSave

Methods inherited from class java.lang.Object

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

Field Detail

MAX_WAIT

public static final int MAX_WAIT

See Also:

Constant Field Values

Constructor Detail

AbortCronJobAction

public AbortCronJobAction()

Method Detail

perform

public ActionResult perform(ActionEvent event)
                     throws JaloBusinessException

Tries to abort the CronJob, which is passed as part of the ActionEvent. The following preconditions must be fulfilled, so that the CronJob can be aborted:

• The CronJob must be passed with the ActionEvent
• The CronJob must be changeable (the current user must have sufficent rights to change the CronJob)
• The CronJob must be currently running and the current Step / Job must be abortable

Specified by:

perform in interface HMCAction

Specified by:

perform in class ItemAction

Parameters:

event - the event

Returns:

the result of the action

Throws:

JaloBusinessException

See Also:

HMCAction.perform(de.hybris.platform.hmc.util.action.ActionEvent)

isActive

public boolean isActive(ActionEvent event)

Returns true, if the action is active. In order to be active, the following preconditions must be fulfilled:

• The CronJob must be passed with the ActionEvent
• The CronJob must be changeable (the current user must have sufficent rights to change the CronJob)
• The CronJob must be currently running
• The current Step (Step.isAbortable()) / the Job must be abortable

Specified by:

isActive in interface HMCStatefulAction

Overrides:

isActive in class ItemAction

Parameters:

event - the actionEvent

Returns:

true, if the action is active

See Also:

HMCStatefulAction.isActive(de.hybris.platform.hmc.util.action.ActionEvent)