org.nuxeo.ecm.platform.actions
Class ActionService

java.lang.Object
  org.nuxeo.runtime.model.DefaultComponent
      org.nuxeo.ecm.platform.actions.ActionService

All Implemented Interfaces:

Serializable, ActionManager, Adaptable, Component, Extensible

public class ActionService
extends DefaultComponent
implements ActionManager

Author:

Bogdan Stefanescu

See Also:

Serialized Form

Field Summary

static ComponentName

ID

Constructor Summary

ActionService()

Method Summary

void	activate(ComponentContext context) Activates the component.
void	deactivate(ComponentContext context) Deactivates the component.
Action	getAction(String actionId)
ActionRegistry	getActionRegistry()
List<Action>	getActions(String category, ActionContext context)
List<Action>	getActions(String category, ActionContext context, boolean hideUnavailableActions)
ActionFilterRegistry	getFilterRegistry()
ActionFilter[]	getFilters(String actionId)
boolean	isEnabled(Action action, ActionContext context)
boolean	isEnabled(String actionId, ActionContext context)
boolean	isRegistered(String actionId)
protected Action	mergeActions(Action existingOne, Action newOne) Merges two actions.
void	registerActionExtension(Extension extension)
void	registerExtension(Extension extension) Registers the given extension.
void	registerFilterExtension(Extension extension)
void	remove() Cleanup method.
void	unregisterActionExtension(Extension extension)
void	unregisterExtension(Extension extension) Unregisters the given extension.
void	unregisterFilterExtension(Extension extension)

Methods inherited from class org.nuxeo.runtime.model.DefaultComponent

getAdapter, registerContribution, unregisterContribution

Methods inherited from class java.lang.Object

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

Field Detail

ID

public static final ComponentName ID

Constructor Detail

ActionService

public ActionService()

Method Detail

activate

public void activate(ComponentContext context)

Description copied from interface: Component

Activates the component.

This method will be called by the runtime when a component is activated.

Specified by:

activate in interface Component

Overrides:

activate in class DefaultComponent

Parameters:

context - the runtime context

deactivate

public void deactivate(ComponentContext context)

Description copied from interface: Component

Deactivates the component.

This method will be called by the runtime when a component is deactivated.

Specified by:

deactivate in interface Component

Overrides:

deactivate in class DefaultComponent

Parameters:

context - the runtime context

getActionRegistry

public ActionRegistry getActionRegistry()

getFilterRegistry

public ActionFilterRegistry getFilterRegistry()

getActions

public List<Action> getActions(String category,
                               ActionContext context)

Specified by:

getActions in interface ActionManager

getActions

public List<Action> getActions(String category,
                               ActionContext context,
                               boolean hideUnavailableActions)

Specified by:

getActions in interface ActionManager

getAction

public Action getAction(String actionId)

Specified by:

getAction in interface ActionManager

isRegistered

public boolean isRegistered(String actionId)

Specified by:

isRegistered in interface ActionManager

isEnabled

public boolean isEnabled(String actionId,
                         ActionContext context)

Specified by:

isEnabled in interface ActionManager

isEnabled

public boolean isEnabled(Action action,
                         ActionContext context)

getFilters

public ActionFilter[] getFilters(String actionId)

Specified by:

getFilters in interface ActionManager

registerExtension

public void registerExtension(Extension extension)

Description copied from interface: Extensible

Registers the given extension.

Specified by:

registerExtension in interface Extensible

Overrides:

registerExtension in class DefaultComponent

Parameters:

extension - the extension to register

unregisterExtension

public void unregisterExtension(Extension extension)

Description copied from interface: Extensible

Unregisters the given extension.

Specified by:

unregisterExtension in interface Extensible

Overrides:

unregisterExtension in class DefaultComponent

Parameters:

extension - the extension to unregister

registerFilterExtension

public void registerFilterExtension(Extension extension)

unregisterFilterExtension

public void unregisterFilterExtension(Extension extension)

registerActionExtension

public void registerActionExtension(Extension extension)

unregisterActionExtension

public void unregisterActionExtension(Extension extension)

mergeActions

protected Action mergeActions(Action existingOne,
                              Action newOne)

Merges two actions. Used when registering an existing action to overload its configuration or add items to its properties.

Single properties are overloaded only when redefined (icon, enabled, order, etc.), while multiple properties are merged with existing ones (categories).

Parameters:

existingOne - the existing action

newOne - the new action

Returns:

a merged Action

remove

public void remove()

Description copied from interface: ActionManager

Cleanup method.

Specified by:

remove in interface ActionManager