org.exoplatform.services.cms.link

Interface LinkManager

public interface LinkManager

Supplies API to work with the linked node or the link included in a node.

Level API:

Platform

Method Summary

Methods

Modifier and Type	Method and Description
javax.jcr.Node	createLink(javax.jcr.Node parent, javax.jcr.Node target) Creates a new link with "exo:symlink" type.
javax.jcr.Node	createLink(javax.jcr.Node parent, String linkType, javax.jcr.Node target) Creates a new link with a given type.
javax.jcr.Node	createLink(javax.jcr.Node parent, String linkType, javax.jcr.Node target, String linkName) Creates a new link with given type and name.
javax.jcr.Node	createLink(javax.jcr.Node parent, String linkType, javax.jcr.Node target, String linkName, String linkTitle) Creates a new link with given type, name and title.
List<javax.jcr.Node>	getAllLinks(javax.jcr.Node targetNode, String linkType) Gets all links of a target node by a given link type.
List<javax.jcr.Node>	getAllLinks(javax.jcr.Node targetNode, String linkType, SessionProvider sessionProvider) Gets all links of a target node by a given link type.
javax.jcr.Node	getTarget(javax.jcr.Node link) Gets the target node of a given link using the user session.
javax.jcr.Node	getTarget(javax.jcr.Node link, boolean system) Gets the target node of a given link.
String	getTargetPrimaryNodeType(javax.jcr.Node link) Gets the primary nodetype of a target node by a given link.
boolean	isLink(javax.jcr.Item item) Checks if a given item is link.
boolean	isTargetReachable(javax.jcr.Node link) Checks if the target node of a given link can be reached using the user session.
boolean	isTargetReachable(javax.jcr.Node link, boolean system) Checks if the target node of a given link can be reached using the user session.
javax.jcr.Node	updateLink(javax.jcr.Node link, javax.jcr.Node target) Updates a link node.
void	updateSymlink(javax.jcr.Node link) Updates information for a symlink, including "exo:title", "exo:dateCreated", "exo:dateModified", "publication:liveDate" and "exo:index".

Method Detail

createLink

javax.jcr.Node createLink(javax.jcr.Node parent,
                        String linkType,
                        javax.jcr.Node target)
                          throws javax.jcr.RepositoryException

Creates a new link with a given type.

Parameters:

parent - The parent node that contains the new link.

linkType - The primary nodetype of the link that must be sub-type of "exo:symlink". Its default value is "exo:symlink".

target - Target of the link.

Returns:

The created link.

Throws:

javax.jcr.RepositoryException - if the link cannot be created for any reason.

createLink

javax.jcr.Node createLink(javax.jcr.Node parent,
                        javax.jcr.Node target)
                          throws javax.jcr.RepositoryException

Creates a new link with "exo:symlink" type.

Parameters:

parent - The parent node that contains the new link.

target - Target of the link.

Returns:

The created link.

Throws:

javax.jcr.RepositoryException - if the link cannot be created for any reason.

createLink

javax.jcr.Node createLink(javax.jcr.Node parent,
                        String linkType,
                        javax.jcr.Node target,
                        String linkName)
                          throws javax.jcr.RepositoryException

Creates a new link with given type and name.

Parameters:

parent - The parent node that contains the new link.

linkType - The primary nodetype of the link that must be sub-type of "exo:symlink". Its default value is "exo:symlink".

target - Target of the link.

linkName - Name of the link.

Returns:

The created link.

Throws:

javax.jcr.RepositoryException - if the link cannot be created for any reason.

createLink

javax.jcr.Node createLink(javax.jcr.Node parent,
                        String linkType,
                        javax.jcr.Node target,
                        String linkName,
                        String linkTitle)
                          throws javax.jcr.RepositoryException

Creates a new link with given type, name and title.

Parameters:

parent - The parent node that contains the new link.

linkType - The primary nodetype of the link that must be sub-type of "exo:symlink". Its default value is "exo:symlink".

target - Target of the link.

linkName - Name of the link.

linkTitle - Title of the link.

Returns:

The created link.

Throws:

javax.jcr.RepositoryException - if the link cannot be created for any reason.

updateLink

javax.jcr.Node updateLink(javax.jcr.Node link,
                        javax.jcr.Node target)
                          throws javax.jcr.RepositoryException

Updates a link node.

Parameters:

link - The link node to be updated.

target - Target of the link node.

Returns:

The updated link node.

Throws:

javax.jcr.RepositoryException - if the link cannot be updated for any reason.

getTarget

javax.jcr.Node getTarget(javax.jcr.Node link,
                       boolean system)
                         throws javax.jcr.ItemNotFoundException,
                                javax.jcr.RepositoryException

Gets the target node of a given link.

Parameters:

link - The node of "exo:symlink" type.

system - Indicates whether the target node must be retrieved using a system or user session. In case the target and the link are not in the same workspace, the system session will be used.

Returns:

The target node.

Throws:

javax.jcr.ItemNotFoundException - if the target node cannot be found.

javax.jcr.RepositoryException - if an unexpected error occurs while retrieving the target node.

getTarget

javax.jcr.Node getTarget(javax.jcr.Node link)
                         throws javax.jcr.ItemNotFoundException,
                                javax.jcr.RepositoryException

Gets the target node of a given link using the user session.

Parameters:

link - The node of "exo:symlink" type.

Returns:

The target node.

Throws:

javax.jcr.ItemNotFoundException - if the target node cannot be found.

javax.jcr.RepositoryException - if an unexpected error occurs while retrieving the target node

isTargetReachable

boolean isTargetReachable(javax.jcr.Node link)
                          throws javax.jcr.RepositoryException

Checks if the target node of a given link can be reached using the user session.

Parameters:

link - The node of "exo:symlink" type.

Returns:

"True" if the target node is reachable. Otherwise, it returns "false".

Throws:

javax.jcr.RepositoryException - if an unexpected error occurs.

isTargetReachable

boolean isTargetReachable(javax.jcr.Node link,
                        boolean system)
                          throws javax.jcr.RepositoryException

Checks if the target node of a given link can be reached using the user session.

Parameters:

link - The node of "exo:symlink" type.

system - The boolean value which indicates if the system session is needed.

Returns:

"True" if the target node is reachable. Otherwise, it returns "false".

Throws:

javax.jcr.RepositoryException - if an unexpected error occurs.

isLink

boolean isLink(javax.jcr.Item item)
               throws javax.jcr.RepositoryException

Checks if a given item is link.

Parameters:

item - The item to be checked.

Returns:

"True" if the given item is link. Otherwise, it returns "false".

Throws:

javax.jcr.RepositoryException - if an unexpected error occurs

getTargetPrimaryNodeType

String getTargetPrimaryNodeType(javax.jcr.Node link)
                                throws javax.jcr.RepositoryException

Gets the primary nodetype of a target node by a given link.

Parameters:

link - The given link.

Returns:

The primary nodetype of the target node.

Throws:

javax.jcr.RepositoryException - if an unexpected error occurs.

getAllLinks

List<javax.jcr.Node> getAllLinks(javax.jcr.Node targetNode,
                               String linkType)
                                 throws Exception

Gets all links of a target node by a given link type.

Parameters:

targetNode - The target node.

linkType - The given link type.

Returns:

The list of links.

Throws:

Exception

getAllLinks

List<javax.jcr.Node> getAllLinks(javax.jcr.Node targetNode,
                               String linkType,
                               SessionProvider sessionProvider)
                                 throws Exception

Gets all links of a target node by a given link type.

Parameters:

targetNode - The target node.

linkType - The given link type.

sessionProvider - The session provider.

Returns:

The list of links.

Throws:

Exception

updateSymlink

void updateSymlink(javax.jcr.Node link)
                   throws Exception

Updates information for a symlink, including "exo:title", "exo:dateCreated", "exo:dateModified", "publication:liveDate" and "exo:index".

Parameters:

link - The link node.

Throws:

Exception