|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ActionServiceTransport
This is the interface for over the transport of ActionService. It's job is to tunnel an authentication token for each call.
Method Summary | |
---|---|
Action |
createAction(java.lang.String ticket,
java.lang.String name)
Create a new action |
Action |
createAction(java.lang.String ticket,
java.lang.String name,
java.util.Map params)
Create a new action specifying the initial set of parameter values |
ActionCondition |
createActionCondition(java.lang.String ticket,
java.lang.String name)
Create an action condition |
ActionCondition |
createActionCondition(java.lang.String ticket,
java.lang.String name,
java.util.Map params)
Create an action condition specifying the initial set of parameter values |
CompositeAction |
createCompositeAction(java.lang.String ticket)
Create a composite action |
boolean |
evaluateAction(java.lang.String ticket,
Action action,
org.alfresco.service.cmr.repository.NodeRef actionedUponNodeRef)
Evaluted the conditions set on an action. |
boolean |
evaluateActionCondition(java.lang.String ticket,
ActionCondition condition,
org.alfresco.service.cmr.repository.NodeRef actionedUponNodeRef)
Evaluate an action condition. |
void |
executeAction(java.lang.String ticket,
Action action,
org.alfresco.service.cmr.repository.NodeRef actionedUponNodeRef)
The actions conditions are always checked. |
void |
executeAction(java.lang.String ticket,
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(java.lang.String ticket,
Action action,
org.alfresco.service.cmr.repository.NodeRef actionedUponNodeRef,
boolean checkConditions,
boolean executeAsynchronously)
Executes the specified action upon the node reference provided. |
Action |
getAction(java.lang.String ticket,
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 ticket,
java.lang.String name)
Get a named action condition definition |
java.util.List |
getActionConditionDefinitions(java.lang.String ticket)
Get all the action condition definitions |
ActionDefinition |
getActionDefinition(java.lang.String ticket,
java.lang.String name)
Get a named action definition |
java.util.List |
getActionDefinitions(java.lang.String ticket)
Get all the action definitions |
java.util.List |
getActionDefinitions(java.lang.String ticket,
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(java.lang.String ticket,
org.alfresco.service.cmr.repository.NodeRef nodeRef)
Gets all the actions currently saved on the given node reference. |
ParameterConstraint |
getParameterConstraint(java.lang.String ticket,
java.lang.String name)
Get a named parameter constraint |
java.util.List |
getParameterConstraints(java.lang.String ticket)
Get all the parameter constraints |
void |
removeAction(java.lang.String ticket,
org.alfresco.service.cmr.repository.NodeRef nodeRef,
Action action)
Removes an action associated with a node reference. |
void |
removeAllActions(java.lang.String ticket,
org.alfresco.service.cmr.repository.NodeRef nodeRef)
Removes all actions associated with a node reference |
void |
saveAction(java.lang.String ticket,
org.alfresco.service.cmr.repository.NodeRef nodeRef,
Action action)
Save an action against a node reference. |
Method Detail |
---|
ActionDefinition getActionDefinition(java.lang.String ticket, java.lang.String name)
name
- the name of the action definition
java.util.List getActionDefinitions(java.lang.String ticket)
java.util.List getActionDefinitions(java.lang.String ticket, org.alfresco.service.cmr.repository.NodeRef nodeRef)
nodeRef
- the node reference
ActionConditionDefinition getActionConditionDefinition(java.lang.String ticket, java.lang.String name)
name
- the name of the action condition definition
java.util.List getActionConditionDefinitions(java.lang.String ticket)
ParameterConstraint getParameterConstraint(java.lang.String ticket, java.lang.String name)
name
- the name of the parameter constraint
java.util.List getParameterConstraints(java.lang.String ticket)
Action createAction(java.lang.String ticket, java.lang.String name)
name
- the action definition name
Action createAction(java.lang.String ticket, java.lang.String name, java.util.Map params)
name
- the action definition nameparams
- the parameter values
CompositeAction createCompositeAction(java.lang.String ticket)
ActionCondition createActionCondition(java.lang.String ticket, java.lang.String name)
name
- the action condition definition name
ActionCondition createActionCondition(java.lang.String ticket, java.lang.String name, java.util.Map params)
name
- the action condition definition nameparams
- the parameter values
void executeAction(java.lang.String ticket, Action action, org.alfresco.service.cmr.repository.NodeRef actionedUponNodeRef)
action
- the actionactionedUponNodeRef
- the actioned upon node referenceActionService.executeAction(Action, NodeRef, boolean)
void executeAction(java.lang.String ticket, Action action, org.alfresco.service.cmr.repository.NodeRef actionedUponNodeRef, boolean checkConditions)
action
- the actionactionedUponNodeRef
- the actioned upon node referencecheckConditions
- indicates whether the conditions should be checkedActionService.executeAction(Action, NodeRef, boolean, boolean)
void executeAction(java.lang.String ticket, Action action, org.alfresco.service.cmr.repository.NodeRef actionedUponNodeRef, boolean checkConditions, boolean executeAsynchronously)
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.
action
- 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 selfboolean evaluateAction(java.lang.String ticket, Action action, org.alfresco.service.cmr.repository.NodeRef actionedUponNodeRef)
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.
action
- the actionactionedUponNodeRef
- the actioned upon node reference
boolean evaluateActionCondition(java.lang.String ticket, ActionCondition condition, org.alfresco.service.cmr.repository.NodeRef actionedUponNodeRef)
condition
- the action conditionactionedUponNodeRef
- the actioned upon node reference
void saveAction(java.lang.String ticket, org.alfresco.service.cmr.repository.NodeRef nodeRef, Action action)
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 referenceaction
- the actionjava.util.List getActions(java.lang.String ticket, org.alfresco.service.cmr.repository.NodeRef nodeRef)
nodeRef
- the node reference
Action getAction(java.lang.String ticket, org.alfresco.service.cmr.repository.NodeRef nodeRef, java.lang.String actionId)
Returns null if the action can not be found.
nodeRef
- the node referenceactionId
- the action id
void removeAction(java.lang.String ticket, org.alfresco.service.cmr.repository.NodeRef nodeRef, Action action)
nodeRef
- the node referenceaction
- the actionvoid removeAllActions(java.lang.String ticket, org.alfresco.service.cmr.repository.NodeRef nodeRef)
nodeRef
- the node reference
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |