info.magnolia.ui.api.action

Class CommandActionDefinition

java.lang.Object

info.magnolia.ui.api.action.ConfiguredActionDefinition

info.magnolia.ui.api.action.CommandActionDefinition

All Implemented Interfaces:

ActionDefinition

Direct Known Subclasses:

ActivationActionDefinition, DeleteActionDefinition, ExportActionDefinition, ExportYamlActionDefinition, JcrCommandActionDefinition, MarkNodeAsDeletedActionDefinition, RestoreItemPreviousVersionActionDefinition, SaveImportDialogActionDefinition, ZipUploadActionDefinition

public class CommandActionDefinition
extends ConfiguredActionDefinition

A basic action definition useful for actions that delegates to commands.

Constructor Summary

Constructors

Constructor and Description
CommandActionDefinition()

Method Summary

Modifier and Type	Method and Description
String	getCatalog()
String	getCommand()
int	getDelay() Defines the delay (in seconds) after which the command should start, if asynchronous.
Map<String,Object>	getParams()
int	getTimeToWait() Defines how long (in milliseconds) the UI should remain blocked until notifying user that the action will complete in the background, if asynchronous.
boolean	isAlwaysShowSuccessMessage() Defines whether the action should always show the success message, even although the action takes less than #timeToWait.
boolean	isAsynchronous() Defines whether this action should try to run asynchronously, e.g.
boolean	isNotifyUser() Defines whether the action should notify the user in the Pulse, if asynchronous and if it completes in the background.
boolean	isParallel() Deprecated. since 6.2. This property is not supported in new framework. Any action can be executed in parallel. Use scheduler module instead to run non parallel jobs.
void	setAlwaysShowSuccessMessage(boolean alwaysShowSuccessMessage)
void	setAsynchronous(boolean asynchronous)
void	setCatalog(String catalog)
void	setCommand(String command)
void	setDelay(int delay)
void	setNotifyUser(boolean notifyUser)
void	setParallel(boolean isParallel) Deprecated. since 6.2. This property is not supported in new framework. Any action can be executed in parallel. Use scheduler module instead to run non parallel jobs.
void	setParams(Map<String,Object> params)
void	setTimeToWait(int timeToWait)
String	toString()

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

getAvailability, getDescription, getErrorMessage, getFailureMessage, getI18nBasename, getIcon, getImplementationClass, getLabel, getName, getSuccessMessage, setAvailability, setDescription, setErrorMessage, setFailureMessage, setI18nBasename, setIcon, setImplementationClass, setLabel, setName, setSuccessMessage

Methods inherited from class java.lang.Object

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

Methods inherited from interface info.magnolia.ui.api.action.ActionDefinition

getShortcut

Constructor Detail

CommandActionDefinition

public CommandActionDefinition()

Method Detail

getCommand

public String getCommand()

setCommand

public void setCommand(String command)

getCatalog

public String getCatalog()

Returns:

CommandsManager.DEFAULT_CATALOG if not set otherwise.

setCatalog

public void setCatalog(String catalog)

setParams

public void setParams(Map<String,Object> params)

getParams

public Map<String,Object> getParams()

toString

public String toString()

Overrides:

toString in class Object

isAsynchronous

public boolean isAsynchronous()

Defines whether this action should try to run asynchronously, e.g. to avoid blocking the UI.

setAsynchronous

public void setAsynchronous(boolean asynchronous)

getDelay

public int getDelay()

Defines the delay (in seconds) after which the command should start, if asynchronous. Default is 1s.

See Also:

isAsynchronous()

setDelay

public void setDelay(int delay)

isParallel

@Deprecated
public boolean isParallel()

Deprecated. since 6.2. This property is not supported in new framework. Any action can be executed in parallel. Use scheduler module instead to run non parallel jobs.

Defines whether the command may be executed in parallel for multiple items, if asynchronous. Default is true.

See Also:

isAsynchronous()

setParallel

@MgnlDeprecated(since="6.2",
                description="This property is not supported in new framework. Any action can be executed in parallel. Use scheduler module instead to run non parallel jobs.")
 @Deprecated
public void setParallel(boolean isParallel)

Deprecated. since 6.2. This property is not supported in new framework. Any action can be executed in parallel. Use scheduler module instead to run non parallel jobs.

getTimeToWait

public int getTimeToWait()

Defines how long (in milliseconds) the UI should remain blocked until notifying user that the action will complete in the background, if asynchronous. Default is 5000ms.

See Also:

isAsynchronous()

setTimeToWait

public void setTimeToWait(int timeToWait)

isNotifyUser

public boolean isNotifyUser()

Defines whether the action should notify the user in the Pulse, if asynchronous and if it completes in the background. Default is true.

See Also:

isAsynchronous()

setNotifyUser

public void setNotifyUser(boolean notifyUser)

isAlwaysShowSuccessMessage

public boolean isAlwaysShowSuccessMessage()

Defines whether the action should always show the success message, even although the action takes less than #timeToWait.

setAlwaysShowSuccessMessage

public void setAlwaysShowSuccessMessage(boolean alwaysShowSuccessMessage)