de.hybris.platform.cronjob.hmc

Class PerformCronJobAction

java.lang.Object

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

de.hybris.platform.cronjob.hmc.PerformCronJobAction

All Implemented Interfaces:

HMCAction, HMCStatefulAction, Serializable

public class PerformCronJobAction
extends ItemAction

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

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

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.PerformCronJobAction' to find the definition.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PerformCronJobAction()

Method Summary

Modifier and Type	Method and Description
boolean	isActive(ActionEvent event) Returns true, if the action is active.
ActionResult	perform(ActionEvent event) Executes the CronJob, which is passed as part of the ActionEvent.
protected void	runFromServiceLayer(CronJob cronJob)

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

Constructor Detail

PerformCronJobAction

public PerformCronJobAction()

Method Detail

perform

public ActionResult perform(ActionEvent event)
                     throws JaloBusinessException

Executes 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 performable

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)

runFromServiceLayer

protected void runFromServiceLayer(CronJob cronJob)

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 performable

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)