|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.alfresco.repo.action.ActionServiceRemote
public class ActionServiceRemote
Client side implementation of ActionService for remote access.
| Constructor Summary | |
|---|---|
ActionServiceRemote()
|
|
| Method Summary | |
|---|---|
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 |
|---|
public ActionServiceRemote()
| Method Detail |
|---|
public void setClientTicketHolder(ClientTicketHolder holder)
public void setActionServiceTransport(ActionServiceTransport transport)
public Action createAction(java.lang.String name)
ActionService
createAction in interface ActionServicename - the action definition name
public Action createAction(java.lang.String name,
java.util.Map params)
ActionService
createAction in interface ActionServicename - the action definition nameparams - the parameter values
public ActionCondition createActionCondition(java.lang.String name)
ActionService
createActionCondition in interface ActionServicename - the action condition definition name
public ActionCondition createActionCondition(java.lang.String name,
java.util.Map params)
ActionService
createActionCondition in interface ActionServicename - the action condition definition nameparams - the parameter values
public CompositeAction createCompositeAction()
ActionService
createCompositeAction in interface ActionService
public boolean evaluateAction(Action action,
org.alfresco.service.cmr.repository.NodeRef actionedUponNodeRef)
ActionServiceReturns true if the action has no conditions.
If the action has more than one condition their results are combined using the 'AND' logical operator.
evaluateAction in interface ActionServiceaction - the actionactionedUponNodeRef - the actioned upon node reference
public boolean evaluateActionCondition(ActionCondition condition,
org.alfresco.service.cmr.repository.NodeRef actionedUponNodeRef)
ActionService
evaluateActionCondition in interface ActionServicecondition - the action conditionactionedUponNodeRef - the actioned upon node reference
public void executeAction(Action action,
org.alfresco.service.cmr.repository.NodeRef actionedUponNodeRef)
ActionService
executeAction in interface ActionServiceaction - the actionactionedUponNodeRef - the actioned upon node referenceActionService.executeAction(Action, NodeRef, boolean)
public void executeAction(Action action,
org.alfresco.service.cmr.repository.NodeRef actionedUponNodeRef,
boolean checkConditions)
ActionService
executeAction in interface ActionServiceaction - the actionactionedUponNodeRef - the actioned upon node referencecheckConditions - indicates whether the conditions should be checkedActionService.executeAction(Action, NodeRef, boolean, boolean)
public void executeAction(Action action,
org.alfresco.service.cmr.repository.NodeRef actionedUponNodeRef,
boolean checkConditions,
boolean executeAsynchronously)
ActionServiceIf 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.
executeAction in interface ActionServiceaction - the actionactionedUponNodeRef - the actioned upon node referencecheckConditions - indicates whether the conditions should be checked before
executing the actionexecuteAsynchronously - indicates whether the action should be executed asychronously or not, this value overrides
the value set on the action its self
public Action getAction(org.alfresco.service.cmr.repository.NodeRef nodeRef,
java.lang.String actionId)
ActionServiceReturns null if the action can not be found.
getAction in interface ActionServicenodeRef - the node referenceactionId - the action id
public ActionConditionDefinition getActionConditionDefinition(java.lang.String name)
ActionService
getActionConditionDefinition in interface ActionServicename - the name of the action condition definition
public java.util.List getActionConditionDefinitions()
ActionService
getActionConditionDefinitions in interface ActionServicepublic ActionDefinition getActionDefinition(java.lang.String name)
ActionService
getActionDefinition in interface ActionServicename - the name of the action definition
public java.util.List getActionDefinitions()
ActionService
getActionDefinitions in interface ActionServicepublic java.util.List getActionDefinitions(org.alfresco.service.cmr.repository.NodeRef nodeRef)
ActionService
getActionDefinitions in interface ActionServicenodeRef - the node reference
public ParameterConstraint getParameterConstraint(java.lang.String name)
ActionService
getParameterConstraint in interface ActionServicename - the name of the parameter constraint
ActionService.getParameterConstraint(java.lang.String)public java.util.List getParameterConstraints()
ActionService
getParameterConstraints in interface ActionServiceActionService.getParameterConstraints()public java.util.List getActions(org.alfresco.service.cmr.repository.NodeRef nodeRef)
ActionService
getActions in interface ActionServicenodeRef - the node reference
public void removeAction(org.alfresco.service.cmr.repository.NodeRef nodeRef,
Action action)
ActionService
removeAction in interface ActionServicenodeRef - the node referenceaction - the actionpublic void removeAllActions(org.alfresco.service.cmr.repository.NodeRef nodeRef)
ActionService
removeAllActions in interface ActionServicenodeRef - the node reference
public void saveAction(org.alfresco.service.cmr.repository.NodeRef nodeRef,
Action action)
ActionServiceThe node will be made configurable if it is not already.
If the action already exists then its details will be updated.
saveAction in interface ActionServicenodeRef - the node referenceaction - the actionpublic CompositeActionCondition createCompositeActionCondition()
ActionService
createCompositeActionCondition in interface ActionService
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||