|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.alfresco.repo.action.ParameterizedItemImpl
org.alfresco.repo.action.ActionImpl
public class ActionImpl
Action implementation
Constructor Summary | |
---|---|
ActionImpl(Action action)
|
|
ActionImpl(Action action,
java.lang.String actionDefinitionName)
|
|
ActionImpl(org.alfresco.service.cmr.repository.NodeRef nodeRef,
java.lang.String id,
java.lang.String actionDefinitionName)
Constructor |
|
ActionImpl(org.alfresco.service.cmr.repository.NodeRef nodeRef,
java.lang.String id,
java.lang.String actionDefinitionName,
java.util.Map parameterValues)
Constructor |
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(java.util.Map values)
Adds a Map of parameter values to the Action |
java.util.Set |
getActionChain()
Get the action chain |
ActionCondition |
getActionCondition(int index)
Get the action condition at a given index |
java.util.List |
getActionConditions()
Gets a list of the action conditions for this action |
java.lang.String |
getActionDefinitionName()
Get the name of the action definition that relates to this action |
Action |
getCompensatingAction()
Get the compensating action. |
java.util.Date |
getCreatedDate()
Get the date the action was created |
java.lang.String |
getCreator()
Get the name of the user that created the action |
java.lang.String |
getDescription()
Get the description of the action |
boolean |
getExecuteAsychronously()
Gets a value indicating whether the action should be executed asychronously or not. |
java.util.Date |
getExecutionEndDate()
Gets the date that the action (last) finished execution at. |
java.lang.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. |
int |
getExecutionInstance()
When there is more than one instance of the action executing, both with the same ID, which one is this? This crops up most often with persisted actions, with two copies running, one on each of two different target nodes. |
java.util.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. |
java.util.Date |
getModifiedDate()
Get the date that the action was last modified |
java.lang.String |
getModifier()
Get the name of the user that last modified the action |
org.alfresco.service.cmr.repository.NodeRef |
getNodeRef()
Gets the node ref that represents the saved action node. |
java.lang.String |
getRunAsUser()
|
java.lang.String |
getTitle()
Get the title of the action |
java.lang.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 |
setActionChain(java.util.Set actionChain)
Set the action chain |
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 |
setCreatedDate(java.util.Date createdDate)
Set the created date |
void |
setCreator(java.lang.String creator)
Set the creator |
void |
setDescription(java.lang.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 |
setExecutionEndDate(java.util.Date endDate)
Records the date when the action finished execution, normally called by the ActionService when
the action completes or fails. |
void |
setExecutionFailureMessage(java.lang.String message)
Records the message of the exception which caused the Action to fail, if any. |
void |
setExecutionInstance(int instance)
Called by the ActionService when the action begins running. |
void |
setExecutionStartDate(java.util.Date startDate)
Records the date when the action began execution, normally called by the ActionService when
it starts running the action. |
void |
setExecutionStatus(ActionStatus status)
Updates the current execution status. |
void |
setModifiedDate(java.util.Date modifiedDate)
Set the modified date |
void |
setModifier(java.lang.String modifier)
Set the modifier |
void |
setNodeRef(org.alfresco.service.cmr.repository.NodeRef nodeRef)
Set the node reference |
void |
setRunAsUser(java.lang.String runAsUserName)
|
void |
setTitle(java.lang.String title)
Set the title of the action |
void |
setTrackStatus(java.lang.Boolean trackStatus)
Set whether the action should be tracked or not. |
java.lang.String |
toString()
|
Methods inherited from class org.alfresco.repo.action.ParameterizedItemImpl |
---|
equals, getId, getParameterValue, getParameterValues, hashCode, setParameterValue, setParameterValues |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.alfresco.service.cmr.action.ParameterizedItem |
---|
getId, getParameterValue, getParameterValues, setParameterValue, setParameterValues |
Constructor Detail |
---|
public ActionImpl(org.alfresco.service.cmr.repository.NodeRef nodeRef, java.lang.String id, java.lang.String actionDefinitionName)
nodeRef
- the action node reference (null if not saved)id
- the action idactionDefinitionName
- the name of the action definitionpublic ActionImpl(org.alfresco.service.cmr.repository.NodeRef nodeRef, java.lang.String id, java.lang.String actionDefinitionName, java.util.Map parameterValues)
nodeRef
- the action node reference (null if not saved)id
- the action idactionDefinitionName
- the action definition nameparameterValues
- the parameter valuespublic ActionImpl(Action action, java.lang.String actionDefinitionName)
public ActionImpl(Action action)
Method Detail |
---|
public java.lang.String toString()
toString
in class java.lang.Object
public java.lang.String getTitle()
Action
getTitle
in interface Action
public void setTitle(java.lang.String title)
Action
setTitle
in interface Action
title
- the title of the actionpublic java.lang.String getDescription()
Action
getDescription
in interface Action
public void setDescription(java.lang.String description)
Action
setDescription
in interface Action
description
- the description of the actionpublic java.lang.Boolean getTrackStatus()
getTrackStatus
in interface Action
ActionTrackingService
, false if it must NOT be
tracked or null to use the action definition's default.public void setTrackStatus(java.lang.Boolean trackStatus)
Action
setTrackStatus
in interface Action
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.public boolean getExecuteAsychronously()
Action
The default is to execute the action synchronously.
getExecuteAsychronously
in interface Action
public void setExecuteAsynchronously(boolean executeAsynchronously)
Action
setExecuteAsynchronously
in interface Action
executeAsynchronously
- true if the action is to be executed asychronously, false otherwise.public Action getCompensatingAction()
Action
This action is executed if the failure behaviour is to compensate and the action being executed fails.
getCompensatingAction
in interface Action
public void setCompensatingAction(Action action)
Action
setCompensatingAction
in interface Action
action
- the compensating actionpublic java.util.Date getCreatedDate()
Action
getCreatedDate
in interface Action
public void setCreatedDate(java.util.Date createdDate)
createdDate
- the created datepublic java.lang.String getCreator()
Action
getCreator
in interface Action
public void setCreator(java.lang.String creator)
public java.util.Date getModifiedDate()
Action
getModifiedDate
in interface Action
public void setModifiedDate(java.util.Date modifiedDate)
public java.lang.String getModifier()
Action
getModifier
in interface Action
public void setModifier(java.lang.String modifier)
public java.lang.String getActionDefinitionName()
Action
getActionDefinitionName
in interface Action
public boolean hasActionConditions()
Action
hasActionConditions
in interface Action
public int indexOfActionCondition(ActionCondition actionCondition)
Action
indexOfActionCondition
in interface Action
actionCondition
- the action condition
public java.util.List getActionConditions()
Action
getActionConditions
in interface Action
public ActionCondition getActionCondition(int index)
Action
getActionCondition
in interface Action
index
- the index
public void addActionCondition(ActionCondition actionCondition)
Action
addActionCondition
in interface Action
actionCondition
- an action conditionpublic void addActionCondition(int index, ActionCondition actionCondition)
Action
addActionCondition
in interface Action
index
- the indexactionCondition
- the action conditionpublic void setActionCondition(int index, ActionCondition actionCondition)
Action
setActionCondition
in interface Action
index
- the indexactionCondition
- the action conditionpublic void removeActionCondition(ActionCondition actionCondition)
Action
removeActionCondition
in interface Action
actionCondition
- an action conditionpublic void removeAllActionConditions()
Action
removeAllActionConditions
in interface Action
public void setActionChain(java.util.Set actionChain)
actionChain
- the list of actions that lead to this actionpublic java.util.Set getActionChain()
public java.lang.String getRunAsUser()
public void setRunAsUser(java.lang.String runAsUserName)
public org.alfresco.service.cmr.repository.NodeRef getNodeRef()
Action
getNodeRef
in interface Action
public void setNodeRef(org.alfresco.service.cmr.repository.NodeRef nodeRef)
nodeRef
- the node referencepublic void addParameterValues(java.util.Map values)
Action
Map
of parameter values to the Action
addParameterValues
in interface Action
values
- A map of values to be addedpublic int getExecutionInstance()
public void setExecutionInstance(int instance)
public java.util.Date getExecutionStartDate()
Action
getExecutionStartDate
in interface Action
public void setExecutionStartDate(java.util.Date startDate)
ActionService
when
it starts running the action.
public java.util.Date getExecutionEndDate()
Action
getExecutionEndDate
in interface Action
public void setExecutionEndDate(java.util.Date endDate)
ActionService
when
the action completes or fails.
public ActionStatus getExecutionStatus()
Action
getExecutionStatus
in interface Action
public void setExecutionStatus(ActionStatus status)
ActionService
as
it progresses the Action's execution.
public java.lang.String getExecutionFailureMessage()
Action
getExecutionFailureMessage
in interface Action
public void setExecutionFailureMessage(java.lang.String message)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |