Action (Alfresco 5.1.4.1 Public Java API)

org.alfresco.service.cmr.action

All Superinterfaces:

All Known Subinterfaces:

@org.alfresco.api.AlfrescoPublicApi
public interface Action

The rule action interface

Method Summary
void	addActionCondition(ActionCondition actionCondition) Add an action condition to the action
void	addActionCondition(int index, ActionCondition actionCondition) Add an action condition at the given index
void	addParameterValues(Map<String,Serializable> values) Adds a Map of parameter values to the Action
ActionCondition	getActionCondition(int index) Get the action condition at a given index
List<ActionCondition>	getActionConditions() Gets a list of the action conditions for this action
String	getActionDefinitionName() Get the name of the action definition that relates to this action
Action	getCompensatingAction() Get the compensating action.
Date	getCreatedDate() Get the date the action was created
String	getCreator() Get the name of the user that created the action
String	getDescription() Get the description of the action
boolean	getExecuteAsychronously() A guide for the ActionService; Should the action be executed asychronously or not? It is not a general purpose flag to indicate the action is running asychronously.
Date	getExecutionEndDate() Gets the date that the action (last) finished execution at.
String	getExecutionFailureMessage() Gets the message of the exception which caused the Action execution failure, or null if the Action hasn't failed / has been retried.
Date	getExecutionStartDate() Gets the date that the action (last) began executing at.
ActionStatus	getExecutionStatus() Gets the current execution status of the action, such as Running or Completed.
Date	getModifiedDate() Get the date that the action was last modified
String	getModifier() Get the name of the user that last modified the action
NodeRef	getNodeRef() Gets the node ref that represents the saved action node.
String	getTitle() Get the title of the action
Boolean	getTrackStatus()
boolean	hasActionConditions() Indicates whether the action has any conditions specified
int	indexOfActionCondition(ActionCondition actionCondition) Gets the index of an action condition
void	removeActionCondition(ActionCondition actionCondition) Removes an action condition
void	removeAllActionConditions() Removes all action conditions
void	setActionCondition(int index, ActionCondition actionCondition) Replaces the current action condition at the given index with the action condition provided.
void	setCompensatingAction(Action action) Set the compensating action.
void	setDescription(String description) Set the description of the action
void	setExecuteAsynchronously(boolean executeAsynchronously) Set the value that indicates whether the action should be executed asychronously or not.
void	setTitle(String title) Set the title of the action
void	setTrackStatus(Boolean trackStatus) Set whether the action should be tracked or not.

Methods inherited from interface org.alfresco.service.cmr.action.ParameterizedItem

getId, getParameterValue, getParameterValues, setParameterValue, setParameterValues

NodeRef getNodeRef()

Gets the node ref that represents the saved action node. Returns null id unsaved.

the action node reference

getActionDefinitionName

String getActionDefinitionName()

Get the name of the action definition that relates to this action

the action defintion name

Get the title of the action

the title of the action

void setTitle(String title)

Set the title of the action

title - the title of the action

String getDescription()

Get the description of the action

the description of the action

void setDescription(String description)

Set the description of the action

description - the description of the action

Boolean getTrackStatus()

true if the action must be tracked by the ActionTrackingService, false if it must NOT be tracked or null to use the action definition's default.

void setTrackStatus(Boolean trackStatus)

Set whether the action should be tracked or not.

The option of tracking can be null i.e. unset, indicating that the defaults of the action definition should be used. This is to allow manual overriding of the property when it becomes supported by the UI.

trackStatus - true if the action must be tracked by the ActionTrackingService, false if it must NOT be tracked or null to use the action definition's default.

getExecuteAsychronously

boolean getExecuteAsychronously()

A guide for the ActionService; Should the action be executed asychronously or not? It is not a general purpose flag to indicate the action is running asychronously.

The default is to execute the action synchronously.

true if the action should be executed asychronously, false otherwise.

setExecuteAsynchronously

void setExecuteAsynchronously(boolean executeAsynchronously)

Set the value that indicates whether the action should be executed asychronously or not.

executeAsynchronously - true if the action is to be executed asychronously, false otherwise.

getCompensatingAction

Action getCompensatingAction()

Get the compensating action.

This action is executed if the failure behaviour is to compensate and the action being executed fails.

the compensating action

setCompensatingAction

void setCompensatingAction(Action action)

Set the compensating action.

action - the compensating action

Date getCreatedDate()

Get the date the action was created

action creation date

Get the name of the user that created the action

Date getModifiedDate()

Get the date that the action was last modified

aciton modification date

String getModifier()

Get the name of the user that last modified the action

boolean hasActionConditions()

Indicates whether the action has any conditions specified

true if the action has any conditions specified, flase otherwise

indexOfActionCondition

int indexOfActionCondition(ActionCondition actionCondition)

Gets the index of an action condition

actionCondition - the action condition

List<ActionCondition> getActionConditions()

Gets a list of the action conditions for this action

list of action conditions

ActionCondition getActionCondition(int index)

Get the action condition at a given index

the action condition

void addActionCondition(ActionCondition actionCondition)

Add an action condition to the action

actionCondition - an action condition

void addActionCondition(int index,
ActionCondition actionCondition)

Add an action condition at the given index

actionCondition - the action condition

void setActionCondition(int index,
ActionCondition actionCondition)

Replaces the current action condition at the given index with the action condition provided.

actionCondition - the action condition

removeActionCondition

void removeActionCondition(ActionCondition actionCondition)

Removes an action condition

actionCondition - an action condition

removeAllActionConditions

void removeAllActionConditions()

Removes all action conditions

void addParameterValues(Map<String,Serializable> values)

Adds a Map of parameter values to the Action

values - A map of values to be added

getExecutionStartDate

Date getExecutionStartDate()

Gets the date that the action (last) began executing at. Null if the action has not yet been run. For a saved action, this will be the last time at ran.

The date the action (last) began executing at, or null.

Date getExecutionEndDate()

Gets the date that the action (last) finished execution at. Null if the action has not yet been run, or is currently running. For a saved action, this will normally be the last time it finished running.

The date the action last finished exeucting at, or null.

ActionStatus getExecutionStatus()

Gets the current execution status of the action, such as Running or Completed.

The current execution status

getExecutionFailureMessage

String getExecutionFailureMessage()

Gets the message of the exception which caused the Action execution failure, or null if the Action hasn't failed / has been retried.

The exception message, if the action has failed

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