ActionService (Alfresco 5.1.4.1 Public Java API)

org.alfresco.service.cmr.action

Interface ActionService

@org.alfresco.api.AlfrescoPublicApi
public interface ActionService

Action service interface

Method Summary
Action	createAction(String name) Create a new action
Action	createAction(String name, Map<String,Serializable> params) Create a new action specifying the initial set of parameter values
ActionCondition	createActionCondition(String name) Create an action condition
ActionCondition	createActionCondition(String name, Map<String,Serializable> 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, NodeRef actionedUponNodeRef) Evaluted the conditions set on an action.
boolean	evaluateActionCondition(ActionCondition condition, NodeRef actionedUponNodeRef) Evaluate an action condition.
void	executeAction(Action action, NodeRef actionedUponNodeRef) The actions conditions are always checked.
void	executeAction(Action action, NodeRef actionedUponNodeRef, boolean checkConditions) The action is executed based on the asynchronous attribute of the action.
void	executeAction(Action action, NodeRef actionedUponNodeRef, boolean checkConditions, boolean executeAsynchronously) Executes the specified action upon the node reference provided.
Action	getAction(NodeRef nodeRef, String actionId) Gets an action stored against a given node reference.
ActionConditionDefinition	getActionConditionDefinition(String name) Get a named action condition definition
List<ActionConditionDefinition>	getActionConditionDefinitions() Get all the action condition definitions
ActionDefinition	getActionDefinition(String name) Get a named action definition
List<ActionDefinition>	getActionDefinitions() Get all the action definitions
List<ActionDefinition>	getActionDefinitions(NodeRef nodeRef) Get all the action definitions that are applicable for the given node, based on its type and aspects.
List<Action>	getActions(NodeRef nodeRef) Gets all the actions currently saved on the given node reference.
ParameterConstraint	getParameterConstraint(String name) Get a named parameter constraint
List<ParameterConstraint>	getParameterConstraints() Get all the parameter constraints
void	removeAction(NodeRef nodeRef, Action action) Removes an action associated with a node reference.
void	removeAllActions(NodeRef nodeRef) Removes all actions associated with a node reference
void	saveAction(NodeRef nodeRef, Action action) Save an action against a node reference.

@Auditable(parameters="name")
ActionDefinition getActionDefinition(String name)

Get a named action definition

name - the name of the action definition

the action definition

getActionDefinitions

@Auditable
List<ActionDefinition> getActionDefinitions()

Get all the action definitions

the list action definitions

getActionDefinitions

@Auditable(parameters="nodeRef")
List<ActionDefinition> getActionDefinitions(NodeRef nodeRef)

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

nodeRef - the node reference

a list of applicable action definitions

getActionConditionDefinition

@Auditable(parameters="name")
ActionConditionDefinition getActionConditionDefinition(String name)

Get a named action condition definition

name - the name of the action condition definition

the action condition definition

getActionConditionDefinitions

@Auditable(parameters={})
List<ActionConditionDefinition> getActionConditionDefinitions()

Get all the action condition definitions

the list of action condition definitions

getParameterConstraint

@Auditable(parameters="name")
ParameterConstraint getParameterConstraint(String name)

Get a named parameter constraint

name - the name of the parameter constraint

this parameter condition

getParameterConstraints

@Auditable(parameters={})
List<ParameterConstraint> getParameterConstraints()

Get all the parameter constraints

the list of all parameter constraints

@Auditable(parameters="name")
Action createAction(String name)

name - the action definition name

@Auditable(parameters={
  "name",
  "params"
})
Action createAction(String name,
                    Map<String,Serializable> params)

Create a new action specifying the initial set of parameter values

name - the action definition name

params - the parameter values

createCompositeAction

@Auditable
CompositeAction createCompositeAction()

Create a composite action

the composite action

createActionCondition

@Auditable(parameters="name")
ActionCondition createActionCondition(String name)

Create an action condition

name - the action condition definition name

the action condition

createActionCondition

@Auditable(parameters={
  "name",
  "params"
})
ActionCondition createActionCondition(String name,
                                      Map<String,Serializable> params)

Create an action condition specifying the initial set of parameter values

name - the action condition definition name

params - the parameter values

the action condition

createCompositeActionCondition

@Auditable
CompositeActionCondition createCompositeActionCondition()

Create a composite actionCondition

the composite actionCondition

@Auditable(parameters={
  "action",
  "actionedUponNodeRef"
})
void executeAction(Action action,
                   NodeRef actionedUponNodeRef)

The actions conditions are always checked.

actionedUponNodeRef - the actioned upon node reference

@Auditable(parameters={
  "action",
  "actionedUponNodeRef",
  "checkConditions"
})
void executeAction(Action action,
                   NodeRef actionedUponNodeRef,
                   boolean checkConditions)

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

actionedUponNodeRef - the actioned upon node reference

checkConditions - indicates whether the conditions should be checked

@Auditable(parameters={
  "action",
  "actionedUponNodeRef",
  "checkConditions",
  "executeAsynchronously"
})
void executeAction(Action action,
                   NodeRef actionedUponNodeRef,
                   boolean checkConditions,
                   boolean executeAsynchronously)

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.

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

@Auditable(parameters={
  "action",
  "actionedUponNodeRef"
})
boolean evaluateAction(Action action,
                       NodeRef actionedUponNodeRef)

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.

actionedUponNodeRef - the actioned upon node reference

true if the condition succeeds, false otherwise

evaluateActionCondition

@Auditable(parameters={
  "condition",
  "actionedUponNodeRef"
})
boolean evaluateActionCondition(ActionCondition condition,
                                NodeRef actionedUponNodeRef)

Evaluate an action condition.

condition - the action condition

actionedUponNodeRef - the actioned upon node reference

true if the condition succeeds, false otherwise

@Auditable(parameters={
  "nodeRef",
  "action"
})
void saveAction(NodeRef nodeRef,
                Action action)

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.

nodeRef - the node reference

@Auditable(parameters="nodeRef")
List<Action> getActions(NodeRef nodeRef)

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

nodeRef - the node reference

@Auditable(parameters={
  "nodeRef",
  "actionId"
})
Action getAction(NodeRef nodeRef,
                 String actionId)

Gets an action stored against a given node reference.

Returns null if the action can not be found.

nodeRef - the node reference

actionId - the action id

@Auditable(parameters={
  "nodeRef",
  "action"
})
void removeAction(NodeRef nodeRef,
                  Action action)

Removes an action associated with a node reference.

nodeRef - the node reference

@Auditable(parameters="nodeRef")
void removeAllActions(NodeRef nodeRef)

Removes all actions associated with a node reference

nodeRef - the node reference

Java API documentation generated with DocFlex/Javadoc 1.6.1 using JavadocPro template set.