org.nuxeo.ecm.platform.actions

Class Action

java.lang.Object

org.nuxeo.ecm.platform.actions.Action

All Implemented Interfaces:

Serializable, Cloneable, Comparable<Action>

public class Action
extends Object
implements Serializable, Cloneable, Comparable<Action>

Descriptor for action.

Author:

Bogdan Stefanescu

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String[]	EMPTY_CATEGORIES

Constructor Summary

Constructors

Constructor and Description
Action()
Action(String id, String[] categories)

Method Summary

Methods

Modifier and Type	Method and Description
Action	clone()
int	compareTo(Action anotherAction)
boolean	equals(Object other)
String	getAccessKey()
boolean	getAvailable()
String[]	getCategories()
List<String>	getCategoryList() Returns the categories as a list.
String	getConfirm() Returns the confirm javascript for this element.
List<String>	getFilterIds()
ActionFilter[]	getFilters()
String	getHelp()
String	getIcon()
String	getId()
String	getLabel()
String	getLink() Returns the link for this action.
Class[]	getLinkParams() Deprecated. since 5.6: useless now that EL expressions support parameters
int	getOrder() Returns the action order.
Map<String,Serializable>	getProperties() Returns an aggregate of localProperties and properties set via descriptors.
ActionPropertiesDescriptor	getPropertiesDescriptor()
String	getType()
int	hashCode()
boolean	isEnabled()
boolean	isEnableSet() Returns true if the enabled element was set on the descriptor, useful for merging.
boolean	isImmediate()
void	setAccessKey(String accessKey)
void	setAvailable(boolean available)
void	setCategories(String[] categories)
void	setConfirm(String confirm)
void	setEnabled(boolean enabled)
void	setFilterIds(List<String> filterIds)
void	setFilters(ActionFilter[] filters)
void	setHelp(String title)
void	setIcon(String icon)
void	setImmediate(boolean immediate)
void	setLabel(String label)
void	setLink(String link)
void	setLinkParams(Class<?>[] linkParams) Deprecated. since 5.6: useless now that EL expressions support parameters
void	setOrder(int order) Sets the order of the action.
void	setProperties(Map<String,Serializable> localProperties) Sets local properties programatically
void	setPropertiesDescriptor(ActionPropertiesDescriptor properties)
void	setType(String type)
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

EMPTY_CATEGORIES

public static final String[] EMPTY_CATEGORIES

Constructor Detail

Action

public Action()

Action

public Action(String id,
      String[] categories)

Method Detail

isEnableSet

public boolean isEnableSet()

Returns true if the enabled element was set on the descriptor, useful for merging.

Since:

5.8

isEnabled

public boolean isEnabled()

setEnabled

public void setEnabled(boolean enabled)

getLabel

public String getLabel()

setLabel

public void setLabel(String label)

getIcon

public String getIcon()

setIcon

public void setIcon(String icon)

getLink

public String getLink()

Returns the link for this action.

Since 5.7.3, fallbacks on properties when link is not set and retrieve it using key "link".

setLink

public void setLink(String link)

getCategories

public String[] getCategories()

getCategoryList

public List<String> getCategoryList()

Returns the categories as a list.

Since:

7.2

getId

public String getId()

toString

public String toString()

Overrides:

toString in class Object

getOrder

public int getOrder()

Returns the action order.

Returns:

the action order as an integer value

setOrder

public void setOrder(int order)

Sets the order of the action.

Parameters:

order - order of the action

compareTo

public int compareTo(Action anotherAction)

Specified by:

compareTo in interface Comparable<Action>

getFilterIds

public List<String> getFilterIds()

setFilterIds

public void setFilterIds(List<String> filterIds)

getFilters

public ActionFilter[] getFilters()

setFilters

public void setFilters(ActionFilter[] filters)

setCategories

public void setCategories(String[] categories)

getLinkParams

@Deprecated
public Class[] getLinkParams()

Deprecated. since 5.6: useless now that EL expressions support parameters

setLinkParams

@Deprecated
public void setLinkParams(Class<?>[] linkParams)

Deprecated. since 5.6: useless now that EL expressions support parameters

getConfirm

public String getConfirm()

Returns the confirm javascript for this element.

Since 5.7.3, fallbacks on properties when link is not set and retrieve it using key "confirm".

setConfirm

public void setConfirm(String confirm)

getAvailable

public boolean getAvailable()

setAvailable

public void setAvailable(boolean available)

getHelp

public String getHelp()

setHelp

public void setHelp(String title)

isImmediate

public boolean isImmediate()

setImmediate

public void setImmediate(boolean immediate)

getType

public String getType()

Since:

5.6

setType

public void setType(String type)

Since:

5.6

getPropertiesDescriptor

public ActionPropertiesDescriptor getPropertiesDescriptor()

Since:

5.6

setPropertiesDescriptor

public void setPropertiesDescriptor(ActionPropertiesDescriptor properties)

Since:

5.6

setProperties

public void setProperties(Map<String,Serializable> localProperties)

Sets local properties programatically

Since:

5.6

getProperties

public Map<String,Serializable> getProperties()

Returns an aggregate of localProperties and properties set via descriptors.

Since:

5.6

setAccessKey

public void setAccessKey(String accessKey)

Since:

5.6

getAccessKey

public String getAccessKey()

Since:

5.6

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public Action clone()

Overrides:

clone in class Object