org.exoplatform.services.cms.actions

Interface ActionServiceContainer

All Known Implementing Classes:

ActionServiceContainerImpl

public interface ActionServiceContainer

Author:

exo

Method Summary

Modifier and Type	Method and Description
void	addAction(javax.jcr.Node node, String type, boolean isDeep, String[] uuid, String[] nodeTypeNames, Map mappings) Add mixintype = exo:actionable to current node Add new node to current node with nodetype = type
void	addAction(javax.jcr.Node node, String type, Map mappings) Add mixintype = exo:actionable to current node Add new node to current node with nodetype = type
void	createActionType(String actionTypeName, String parentActionTypeName, String executable, String actionLabel, List<String> variableNames, boolean isMoveType, boolean isUpdate) Create NodeTypeValue is in kind of ActionType following action type name
void	executeAction(String userId, javax.jcr.Node node, String actionName) Execute action following userId, node, repository, initiated variables
void	executeAction(String userId, javax.jcr.Node node, String actionName, Map variables) Execute action following userId, node, variables, repository
javax.jcr.Node	getAction(javax.jcr.Node node, String actionName) get node by using actionName as relative path with current node
ActionPlugin	getActionPlugin(String actionServiceName) Get ActionPlugin following ActionSeriveName
ActionPlugin	getActionPluginForActionType(String actionTypeName) Get ActionPlugin following action type name
Collection<String>	getActionPluginNames() Collection of String
List<javax.jcr.Node>	getActions(javax.jcr.Node node) Get list of child node with NodeType = exo:action
List<javax.jcr.Node>	getActions(javax.jcr.Node node, String lifecyclePhase) Get list of child node with exo:lifecyclePhase = lifecyclePhase
Collection<javax.jcr.nodetype.NodeType>	getCreatedActionTypes(String repository) Get all created node with nodetype = "exo:action
List<javax.jcr.Node>	getCustomActionsNode(javax.jcr.Node node, String lifecyclePhase) Get list of node that have same level with current node, exo:lifecyclePhase = lifecyclePhase
boolean	hasActions(javax.jcr.Node node) Check node type is exo:actionable or not
void	init() Init all available action plugins.
void	initiateObservation(javax.jcr.Node node) Add action listener for all action child node of current node in current repository
void	removeAction(javax.jcr.Node node, String repository) Remove all action registered in node
void	removeAction(javax.jcr.Node node, String actionName, String repository) Remove all relative node of current node with node type = exo:actionable

Method Detail

getActionPluginNames

Collection<String> getActionPluginNames()

Collection of String

Returns:

collection of ActionPlugin namess

getActionPlugin

ActionPlugin getActionPlugin(String actionServiceName)

Get ActionPlugin following ActionSeriveName

Parameters:

actionServiceName - name of action service

Returns:

ActionPlugin

getActionPluginForActionType

ActionPlugin getActionPluginForActionType(String actionTypeName)

Get ActionPlugin following action type name

Parameters:

actionTypeName - name of action type

Returns:

ActionPlugin

createActionType

void createActionType(String actionTypeName,
                      String parentActionTypeName,
                      String executable,
                      String actionLabel,
                      List<String> variableNames,
                      boolean isMoveType,
                      boolean isUpdate)
               throws Exception

Create NodeTypeValue is in kind of ActionType following action type name

Parameters:

actionTypeName - name of action type

parentActionTypeName - name of parent action

executable - String value of executable

actionLabel - Label of action type

variableNames - List name of variable

isMoveType - is moved or not

isUpdate - True if the action type is updating

Throws:

Exception

getCreatedActionTypes

Collection<javax.jcr.nodetype.NodeType> getCreatedActionTypes(String repository)
                                                       throws Exception

Get all created node with nodetype = "exo:action

Parameters:

repository - repository name

Returns:

Collection of NodeType

Throws:

Exception

getAction

javax.jcr.Node getAction(javax.jcr.Node node,
                         String actionName)
                  throws Exception

get node by using actionName as relative path with current node

Parameters:

node - current processing node

actionName - name of action

Returns:

Node

Throws:

Exception

hasActions

boolean hasActions(javax.jcr.Node node)
            throws Exception

Check node type is exo:actionable or not

Parameters:

node -

Returns:

true: NodeType is exo:actionable false NodeType is not exo:actionable

Throws:

Exception

getActions

List<javax.jcr.Node> getActions(javax.jcr.Node node)
                         throws Exception

Get list of child node with NodeType = exo:action

Parameters:

node - current node

Returns:

list of node

Throws:

Exception

getCustomActionsNode

List<javax.jcr.Node> getCustomActionsNode(javax.jcr.Node node,
                                          String lifecyclePhase)
                                   throws Exception

Get list of node that have same level with current node, exo:lifecyclePhase = lifecyclePhase

Parameters:

node - current node

lifecyclePhase - exo:lifecyclePhase value

Returns:

list of node

Throws:

Exception

getActions

List<javax.jcr.Node> getActions(javax.jcr.Node node,
                                String lifecyclePhase)
                         throws Exception

Get list of child node with exo:lifecyclePhase = lifecyclePhase

Parameters:

node - current node

lifecyclePhase - exo:lifecyclePhase value

Returns:

list of node

Throws:

Exception

removeAction

void removeAction(javax.jcr.Node node,
                  String repository)
           throws Exception

Remove all action registered in node

Parameters:

node -

repository -

Throws:

Exception

removeAction

void removeAction(javax.jcr.Node node,
                  String actionName,
                  String repository)
           throws Exception

Remove all relative node of current node with node type = exo:actionable

Parameters:

node - current node

actionName - relative path = exo:actionable / actionName

repository - repository name

Throws:

Exception

addAction

void addAction(javax.jcr.Node node,
               String type,
               Map mappings)
        throws Exception

Add mixintype = exo:actionable to current node Add new node to current node with nodetype = type

Parameters:

node - current node

type - nodetype name

mappings - value of property for adding to new node

Throws:

Exception

addAction

void addAction(javax.jcr.Node node,
               String type,
               boolean isDeep,
               String[] uuid,
               String[] nodeTypeNames,
               Map mappings)
        throws Exception

Add mixintype = exo:actionable to current node Add new node to current node with nodetype = type

Parameters:

node - current node

type - nodetype name

isDeep - affect to child node of node

uuid - affect only to parent node of event having given uuid

nodeTypeNames - affect to parent node of event having nodetype in nodeTypeNames

mappings - value of property for adding to new node

Throws:

Exception

executeAction

void executeAction(String userId,
                   javax.jcr.Node node,
                   String actionName,
                   Map variables)
            throws Exception

Execute action following userId, node, variables, repository

Parameters:

userId - user identify

node - current node

actionName - name of action

variables - Map with variables and value

Throws:

Exception

executeAction

void executeAction(String userId,
                   javax.jcr.Node node,
                   String actionName)
            throws Exception

Execute action following userId, node, repository, initiated variables

Parameters:

userId - user identify

node - current node

actionName - name of action

Throws:

Exception

See Also:

executeAction(String, Node, String, Map)

initiateObservation

void initiateObservation(javax.jcr.Node node)
                  throws Exception

Add action listener for all action child node of current node in current repository

Parameters:

node - current node

Throws:

Exception

init

void init()
   throws Exception

Init all available action plugins.

Throws:

Exception