org.exoplatform.services.cms.documents

Interface DocumentService

All Known Implementing Classes:

DocumentServiceImpl

public interface DocumentService

Created by The eXo Platform SAS Author : eXoPlatform exo@exoplatform.com Mar 22, 2011

Method Summary

Modifier and Type	Method and Description
Document	findDocById(String id)
default String	getDocumentUrlInPersonalDocuments(javax.jcr.Node currentNode, String username) return the URL of the shared document in the Shared Personal Documents folder of the user destination
default String	getDocumentUrlInSpaceDocuments(javax.jcr.Node currentNode, String spaceId) return the URL of the shared document in the Shared Documents folder of the space destination
DriveData	getDriveOfNode(String nodePath) Get the drive containing the node with the given node path, for the current user.
DriveData	getDriveOfNode(String nodePath, String userId, List<String> memberships) Get the drive containing the node with the given node path.
String	getLinkInDocumentsApp(String nodePath) Get the link to display a document in the Documents app.
String	getLinkInDocumentsApp(String nodePath, DriveData drive) Get the link to display a document in the Documents app in the given drive.
String	getShortLinkInDocumentsApp(String workspaceName, String nodeId) Get the short link to display a document in the Documents app by its id.

Method Detail

findDocById

Document findDocById(String id)
              throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

getShortLinkInDocumentsApp

String getShortLinkInDocumentsApp(String workspaceName,
                                  String nodeId)
                           throws Exception

Get the short link to display a document in the Documents app by its id.

Parameters:

workspaceName - The workspace of the node

nodeId - The id of the node

Returns:

The link to open the document

Throws:

Exception

getDocumentUrlInPersonalDocuments

default String getDocumentUrlInPersonalDocuments(javax.jcr.Node currentNode,
                                                 String username)
                                          throws Exception

return the URL of the shared document in the Shared Personal Documents folder of the user destination

Parameters:

currentNode -

username -

Returns:

Throws:

Exception

getDocumentUrlInSpaceDocuments

default String getDocumentUrlInSpaceDocuments(javax.jcr.Node currentNode,
                                              String spaceId)
                                       throws Exception

return the URL of the shared document in the Shared Documents folder of the space destination

Parameters:

currentNode -

spaceId -

Returns:

Throws:

Exception

getLinkInDocumentsApp

String getLinkInDocumentsApp(String nodePath)
                      throws Exception

Get the link to display a document in the Documents app. It will try to get the best matching context (personal doc, space doc, ...).

Parameters:

nodePath - The path of the node

Returns:

The link to open the document

Throws:

Exception

getLinkInDocumentsApp

String getLinkInDocumentsApp(String nodePath,
                             DriveData drive)
                      throws Exception

Get the link to display a document in the Documents app in the given drive. It will try to get the best matching context (personal doc, space doc, ...).

Parameters:

nodePath - The path of the node

drive - The drive to use

Returns:

The link to open the document

Throws:

Exception

getDriveOfNode

DriveData getDriveOfNode(String nodePath)
                  throws Exception

Get the drive containing the node with the given node path, for the current user. If several drives contain the node, try to find the best matching.

Parameters:

nodePath - The path of the node

Returns:

The drive containing the node

Throws:

Exception

getDriveOfNode

DriveData getDriveOfNode(String nodePath,
                         String userId,
                         List<String> memberships)
                  throws Exception

Get the drive containing the node with the given node path. If several drives contain the node, try to find the best matching.

Parameters:

nodePath - The path of the node

userId - The user id

memberships - The user memberships

Returns:

The drive containing the node

Throws:

Exception