org.exoplatform.services.cms

Interface CmsService

public interface CmsService

Stores and moves nodes based on different criteria.

Level API:

Experimental

Field Summary

Fields

Modifier and Type	Field and Description
static String	NODE Constant string to refer to the property of node in Map.
static String	POST_CREATE_CONTENT_EVENT
static String	POST_EDIT_CONTENT_EVENT
static String	PRE_CREATE_CONTENT_EVENT
static String	PRE_EDIT_CONTENT_EVENT

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,Object>	getPreProperties() Gets all properties of a node.
void	moveNode(String nodePath, String srcWorkspace, String destWorkspace, String destPath) Moves a node from one workspace to the other, with the same repository.
String	storeEditedNode(String nodetypeName, javax.jcr.Node storeNode, Map inputProperties, boolean isAddNew) Stores the edited node in a given repository with given properties used in case that user only has permission to access storeNode but cannot access parent of storeNode (storeHomeNode).
String	storeNode(String nodetypeName, javax.jcr.Node storeHomeNode, Map inputProperties, boolean isAddNew) Stores a node in a given repository with given properties.
String	storeNode(String workspace, String nodetypeName, String storePath, Map inputProperties) Stores a node in a given workspace and repository with given properties.
String	storeNodeByUUID(String nodetypeName, javax.jcr.Node storeNode, Map inputProperties, boolean isAddNew) Stores a node in a repository with given properties.

Field Detail

POST_CREATE_CONTENT_EVENT

static final String POST_CREATE_CONTENT_EVENT

See Also:

Constant Field Values

POST_EDIT_CONTENT_EVENT

static final String POST_EDIT_CONTENT_EVENT

See Also:

Constant Field Values

PRE_CREATE_CONTENT_EVENT

static final String PRE_CREATE_CONTENT_EVENT

See Also:

Constant Field Values

PRE_EDIT_CONTENT_EVENT

static final String PRE_EDIT_CONTENT_EVENT

See Also:

Constant Field Values

NODE

static final String NODE

Constant string to refer to the property of node in Map. For getting properties of a specific node in Map, use key = NODE + propertyName.

See Also:

Constant Field Values

Method Detail

storeNode

String storeNode(String workspace,
               String nodetypeName,
               String storePath,
               Map inputProperties)
                 throws Exception

Stores a node in a given workspace and repository with given properties.

Parameters:

workspace - Name of the workspace.

nodetypeName - Name of the nodetype.

storePath - Path of the store node.

inputProperties - Map of node's properties, including property name and value.

Returns:

Path of the saved node.

Throws:

Exception - The exception

storeNode

String storeNode(String nodetypeName,
               javax.jcr.Node storeHomeNode,
               Map inputProperties,
               boolean isAddNew)
                 throws Exception

Stores a node in a given repository with given properties.

Parameters:

nodetypeName - Name of the nodetype.

storeHomeNode - The parent node where the node is stored.

inputProperties - Map of node's properties, including property name and value.

isAddNew - If "true", the new node is added. If "false", the node is updated.

Returns:

Path to the saved node.

Throws:

Exception - The exception

storeEditedNode

String storeEditedNode(String nodetypeName,
                     javax.jcr.Node storeNode,
                     Map inputProperties,
                     boolean isAddNew)
                       throws Exception

Stores the edited node in a given repository with given properties used in case that user only has permission to access storeNode but cannot access parent of storeNode (storeHomeNode).

Parameters:

nodetypeName - Name of the nodetype.

storeNode - The store node.

inputProperties - Map of node's properties, including property name and value.

isAddNew - If "true", the new node is added. If "false", the node is updated.

Returns:

Path of the saved node.

Throws:

Exception - The exception

storeNodeByUUID

String storeNodeByUUID(String nodetypeName,
                     javax.jcr.Node storeNode,
                     Map inputProperties,
                     boolean isAddNew)
                       throws Exception

Stores a node in a repository with given properties.

Parameters:

nodetypeName - Name of the nodetype.

storeNode - The store node.

inputProperties - Map of node's properties, including property name and value.

isAddNew - If "true", the new node is added. If "false", the node is updated.

Returns:

UUID of the saved node.

Throws:

Exception - The exception

moveNode

void moveNode(String nodePath,
            String srcWorkspace,
            String destWorkspace,
            String destPath)

Moves a node from one workspace to the other, with the same repository.

Parameters:

nodePath - Path to the node in the source workspace.

srcWorkspace - Name of the source workspace.

destWorkspace - Name of the destination workspace.

destPath - Path of the destination node.

getPreProperties

Map<String,Object> getPreProperties()

Gets all properties of a node.

Returns:

Map of properties.