org.alfresco.repo.action

Class ActionServiceRemote

java.lang.Object

org.alfresco.repo.action.ActionServiceRemote

All Implemented Interfaces:

ActionService

public class ActionServiceRemote
extends java.lang.Object
implements ActionService

Client side implementation of ActionService for remote access.

Constructor Summary

Constructors

Constructor and Description
ActionServiceRemote()

Method Summary

Methods

Modifier and Type	Method and Description
Action	createAction(java.lang.String name) Create a new action
Action	createAction(java.lang.String name, java.util.Map params) Create a new action specifying the initial set of parameter values
ActionCondition	createActionCondition(java.lang.String name) Create an action condition
ActionCondition	createActionCondition(java.lang.String name, java.util.Map params) Create an action condition specifying the initial set of parameter values
CompositeAction	createCompositeAction() Create a composite action
CompositeActionCondition	createCompositeActionCondition() Create a composite actionCondition
boolean	evaluateAction(Action action, org.alfresco.service.cmr.repository.NodeRef actionedUponNodeRef) Evaluted the conditions set on an action.
boolean	evaluateActionCondition(ActionCondition condition, org.alfresco.service.cmr.repository.NodeRef actionedUponNodeRef) Evaluate an action condition.
void	executeAction(Action action, org.alfresco.service.cmr.repository.NodeRef actionedUponNodeRef) The actions conditions are always checked.
void	executeAction(Action action, org.alfresco.service.cmr.repository.NodeRef actionedUponNodeRef, boolean checkConditions) The action is executed based on the asynchronous attribute of the action.
void	executeAction(Action action, org.alfresco.service.cmr.repository.NodeRef actionedUponNodeRef, boolean checkConditions, boolean executeAsynchronously) Executes the specified action upon the node reference provided.
Action	getAction(org.alfresco.service.cmr.repository.NodeRef nodeRef, java.lang.String actionId) Gets an action stored against a given node reference.
ActionConditionDefinition	getActionConditionDefinition(java.lang.String name) Get a named action condition definition
java.util.List	getActionConditionDefinitions() Get all the action condition definitions
ActionDefinition	getActionDefinition(java.lang.String name) Get a named action definition
java.util.List	getActionDefinitions() Get all the action definitions
java.util.List	getActionDefinitions(org.alfresco.service.cmr.repository.NodeRef nodeRef) Get all the action definitions that are applicable for the given node, based on its type and aspects.
java.util.List	getActions(org.alfresco.service.cmr.repository.NodeRef nodeRef) Gets all the actions currently saved on the given node reference.
ParameterConstraint	getParameterConstraint(java.lang.String name) Get a named parameter constraint
java.util.List	getParameterConstraints() Get all the parameter constraints
void	removeAction(org.alfresco.service.cmr.repository.NodeRef nodeRef, Action action) Removes an action associated with a node reference.
void	removeAllActions(org.alfresco.service.cmr.repository.NodeRef nodeRef) Removes all actions associated with a node reference
void	saveAction(org.alfresco.service.cmr.repository.NodeRef nodeRef, Action action) Save an action against a node reference.
void	setActionServiceTransport(ActionServiceTransport transport)
void	setClientTicketHolder(ClientTicketHolder holder)

Methods inherited from class java.lang.Object

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

Constructor Detail

ActionServiceRemote

public ActionServiceRemote()

Method Detail

setClientTicketHolder

public void setClientTicketHolder(ClientTicketHolder holder)

setActionServiceTransport

public void setActionServiceTransport(ActionServiceTransport transport)

createAction

public Action createAction(java.lang.String name)

Description copied from interface: ActionService

Create a new action

Specified by:

createAction in interface ActionService

Parameters:

name - the action definition name

Returns:

the action

createAction

public Action createAction(java.lang.String name,
                  java.util.Map params)

Description copied from interface: ActionService

Create a new action specifying the initial set of parameter values

Specified by:

createAction in interface ActionService

Parameters:

name - the action definition name

params - the parameter values

Returns:

the action

createActionCondition

public ActionCondition createActionCondition(java.lang.String name)

Description copied from interface: ActionService

Create an action condition

Specified by:

createActionCondition in interface ActionService

Parameters:

name - the action condition definition name

Returns:

the action condition

createActionCondition

public ActionCondition createActionCondition(java.lang.String name,
                                    java.util.Map params)

Description copied from interface: ActionService

Create an action condition specifying the initial set of parameter values

Specified by:

createActionCondition in interface ActionService

Parameters:

name - the action condition definition name

params - the parameter values

Returns:

the action condition

createCompositeAction

public CompositeAction createCompositeAction()

Description copied from interface: ActionService

Create a composite action

Specified by:

createCompositeAction in interface ActionService

Returns:

the composite action

evaluateAction

public boolean evaluateAction(Action action,
                     org.alfresco.service.cmr.repository.NodeRef actionedUponNodeRef)

Description copied from interface: ActionService

Evaluted the conditions set on an action.

Returns true if the action has no conditions.

If the action has more than one condition their results are combined using the 'AND' logical operator.

Specified by:

evaluateAction in interface ActionService

Parameters:

action - the action

actionedUponNodeRef - the actioned upon node reference

Returns:

true if the condition succeeds, false otherwise

evaluateActionCondition

public boolean evaluateActionCondition(ActionCondition condition,
                              org.alfresco.service.cmr.repository.NodeRef actionedUponNodeRef)

Description copied from interface: ActionService

Evaluate an action condition.

Specified by:

evaluateActionCondition in interface ActionService

Parameters:

condition - the action condition

actionedUponNodeRef - the actioned upon node reference

Returns:

true if the condition succeeds, false otherwise

executeAction

public void executeAction(Action action,
                 org.alfresco.service.cmr.repository.NodeRef actionedUponNodeRef)

Description copied from interface: ActionService

The actions conditions are always checked.

Specified by:

executeAction in interface ActionService

Parameters:

action - the action

actionedUponNodeRef - the actioned upon node reference

See Also:

ActionService.executeAction(Action, NodeRef, boolean)

executeAction

public void executeAction(Action action,
                 org.alfresco.service.cmr.repository.NodeRef actionedUponNodeRef,
                 boolean checkConditions)

Description copied from interface: ActionService

The action is executed based on the asynchronous attribute of the action.

Specified by:

executeAction in interface ActionService

Parameters:

action - the action

actionedUponNodeRef - the actioned upon node reference

checkConditions - indicates whether the conditions should be checked

See Also:

ActionService.executeAction(Action, NodeRef, boolean, boolean)

executeAction

public void executeAction(Action action,
                 org.alfresco.service.cmr.repository.NodeRef actionedUponNodeRef,
                 boolean checkConditions,
                 boolean executeAsynchronously)

Description copied from interface: ActionService

Executes the specified action upon the node reference provided.

If specified that the conditions should be checked then any conditions set on the action are evaluated.

If the conditions fail then the action is not executed.

If an action has no conditions then the action will always be executed.

If the conditions are not checked then the action will always be executed.

Specified by:

executeAction in interface ActionService

Parameters:

action - the action

actionedUponNodeRef - the actioned upon node reference

checkConditions - indicates whether the conditions should be checked before executing the action

executeAsynchronously - indicates whether the action should be executed asychronously or not, this value overrides the value set on the action its self

getAction

public Action getAction(org.alfresco.service.cmr.repository.NodeRef nodeRef,
               java.lang.String actionId)

Description copied from interface: ActionService

Gets an action stored against a given node reference.

Returns null if the action can not be found.

Specified by:

getAction in interface ActionService

Parameters:

nodeRef - the node reference

actionId - the action id

Returns:

the action

getActionConditionDefinition

public ActionConditionDefinition getActionConditionDefinition(java.lang.String name)

Description copied from interface: ActionService

Get a named action condition definition

Specified by:

getActionConditionDefinition in interface ActionService

Parameters:

name - the name of the action condition definition

Returns:

the action condition definition

getActionConditionDefinitions

public java.util.List getActionConditionDefinitions()

Description copied from interface: ActionService

Get all the action condition definitions

Specified by:

getActionConditionDefinitions in interface ActionService

Returns:

the list of action condition definitions

getActionDefinition

public ActionDefinition getActionDefinition(java.lang.String name)

Description copied from interface: ActionService

Get a named action definition

Specified by:

getActionDefinition in interface ActionService

Parameters:

name - the name of the action definition

Returns:

the action definition

getActionDefinitions

public java.util.List getActionDefinitions()

Description copied from interface: ActionService

Get all the action definitions

Specified by:

getActionDefinitions in interface ActionService

Returns:

the list action definitions

getActionDefinitions

public java.util.List getActionDefinitions(org.alfresco.service.cmr.repository.NodeRef nodeRef)

Description copied from interface: ActionService

Get all the action definitions that are applicable for the given node, based on its type and aspects.

Specified by:

getActionDefinitions in interface ActionService

Parameters:

nodeRef - the node reference

Returns:

a list of applicable action definitions

getParameterConstraint

public ParameterConstraint getParameterConstraint(java.lang.String name)

Description copied from interface: ActionService

Get a named parameter constraint

Specified by:

getParameterConstraint in interface ActionService

Parameters:

name - the name of the parameter constraint

Returns:

this parameter condition

See Also:

ActionService.getParameterConstraint(java.lang.String)

getParameterConstraints

public java.util.List getParameterConstraints()

Description copied from interface: ActionService

Get all the parameter constraints

Specified by:

getParameterConstraints in interface ActionService

Returns:

the list of all parameter constraints

See Also:

ActionService.getParameterConstraints()

getActions

public java.util.List getActions(org.alfresco.service.cmr.repository.NodeRef nodeRef)

Description copied from interface: ActionService

Gets all the actions currently saved on the given node reference.

Specified by:

getActions in interface ActionService

Parameters:

nodeRef - the node reference

Returns:

the list of actions

removeAction

public void removeAction(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                Action action)

Description copied from interface: ActionService

Removes an action associated with a node reference.

Specified by:

removeAction in interface ActionService

Parameters:

nodeRef - the node reference

action - the action

removeAllActions

public void removeAllActions(org.alfresco.service.cmr.repository.NodeRef nodeRef)

Description copied from interface: ActionService

Removes all actions associated with a node reference

Specified by:

removeAllActions in interface ActionService

Parameters:

nodeRef - the node reference

saveAction

public void saveAction(org.alfresco.service.cmr.repository.NodeRef nodeRef,
              Action action)

Description copied from interface: ActionService

Save an action against a node reference.

The node will be made configurable if it is not already.

If the action already exists then its details will be updated.

Specified by:

saveAction in interface ActionService

Parameters:

nodeRef - the node reference

action - the action

createCompositeActionCondition

public CompositeActionCondition createCompositeActionCondition()

Description copied from interface: ActionService

Create a composite actionCondition

Specified by:

createCompositeActionCondition in interface ActionService

Returns:

the composite actionCondition