com.openkm.module

Interface RepositoryModule

All Known Implementing Classes:

DbRepositoryModule, JcrRepositoryModule, OKMRepository

public interface RepositoryModule

Method Summary

Methods

Modifier and Type	Method and Description
void	copyAttributes(String token, String srcId, String dstId, ExtendedAttributes extAttr) Copy attributes from a node to another.
AppVersion	getAppVersion(String token) Retrieve application version.
Folder	getCategoriesFolder(String token) Obtain the categories folder of the repository.
Folder	getMailFolder(String token) Obtain the personal mails folder of the repository.
Folder	getMailFolderBase(String token)
String	getNodePath(String token, String uuid) Obtain the node path with a given uuid.
String	getNodeUuid(String token, String path) Obtain the node uuid with a given path.
Folder	getPersonalFolder(String token) Obtain the personal documents folder of the repository.
Folder	getPersonalFolderBase(String token)
String	getRepositoryUuid(String token) Get the unique repository identifier
Folder	getRootFolder(String token) Obtain the root folder of the repository.
Folder	getTemplatesFolder(String token) Obtain the template folder of the repository.
Folder	getThesaurusFolder(String token) Obtain the thesaurus folder of the repository.
Folder	getTrashFolder(String token) Obtains the user trash folder.
Folder	getTrashFolderBase(String token)
String	getUpdateMessage(String token) Get the update message, if any.
boolean	hasNode(String token, String nodeId) Test if a node path exists
void	purgeTrash(String token) Remove all the items in the user trash folder for ever.

Method Detail

getRootFolder

Folder getRootFolder(String token)
                     throws PathNotFoundException,
                            RepositoryException,
                            DatabaseException

Obtain the root folder of the repository.

Returns:

A folder object with the repository root node properties.

Throws:

PathNotFoundException - If there is no root folder node in the repository.

RepositoryException - If there is any general repository problem.

DatabaseException

getTrashFolder

Folder getTrashFolder(String token)
                      throws PathNotFoundException,
                             RepositoryException,
                             DatabaseException

Obtains the user trash folder.

Returns:

A folder object with the user trash node properties.

Throws:

PathNotFoundException - If there is no user trash folder node in the repository.

RepositoryException - If there is any general repository problem.

DatabaseException

getTrashFolderBase

Folder getTrashFolderBase(String token)
                          throws PathNotFoundException,
                                 RepositoryException,
                                 DatabaseException

Throws:

PathNotFoundException

RepositoryException

DatabaseException

getTemplatesFolder

Folder getTemplatesFolder(String token)
                          throws PathNotFoundException,
                                 RepositoryException,
                                 DatabaseException

Obtain the template folder of the repository.

Returns:

A folder object with the templates node properties.

Throws:

PathNotFoundException - If there is no templates folder node in the repository.

RepositoryException - If there is any general repository problem.

DatabaseException

getPersonalFolder

Folder getPersonalFolder(String token)
                         throws PathNotFoundException,
                                RepositoryException,
                                DatabaseException

Obtain the personal documents folder of the repository.

Returns:

A folder object with the user documents folder node properties.

Throws:

PathNotFoundException - If there is no user documents folder node in the repository.

RepositoryException - If there is any general repository problem.

DatabaseException

getPersonalFolderBase

Folder getPersonalFolderBase(String token)
                             throws PathNotFoundException,
                                    RepositoryException,
                                    DatabaseException

Throws:

PathNotFoundException

RepositoryException

DatabaseException

getMailFolder

Folder getMailFolder(String token)
                     throws PathNotFoundException,
                            RepositoryException,
                            DatabaseException

Obtain the personal mails folder of the repository.

Returns:

A folder object with the user mails folder node properties.

Throws:

PathNotFoundException - If there is no user documents folder node in the repository.

RepositoryException - If there is any general repository problem.

DatabaseException

getMailFolderBase

Folder getMailFolderBase(String token)
                         throws PathNotFoundException,
                                RepositoryException,
                                DatabaseException

Throws:

PathNotFoundException

RepositoryException

DatabaseException

getThesaurusFolder

Folder getThesaurusFolder(String token)
                          throws PathNotFoundException,
                                 RepositoryException,
                                 DatabaseException

Obtain the thesaurus folder of the repository.

Returns:

A folder object with the thesaurus folder node properties.

Throws:

PathNotFoundException - If there is no user documents folder node in the repository.

RepositoryException - If there is any general repository problem.

DatabaseException

getCategoriesFolder

Folder getCategoriesFolder(String token)
                           throws PathNotFoundException,
                                  RepositoryException,
                                  DatabaseException

Obtain the categories folder of the repository.

Returns:

A folder object with the categories folder node properties.

Throws:

PathNotFoundException - If there is no user documents folder node in the repository.

RepositoryException - If there is any general repository problem.

DatabaseException

purgeTrash

void purgeTrash(String token)
                throws PathNotFoundException,
                       AccessDeniedException,
                       LockException,
                       RepositoryException,
                       DatabaseException

Remove all the items in the user trash folder for ever. You can't recover this items any more.

Throws:

AccessDeniedException - If there is any security problem: you can't modify the user deleted folders and documents because of lack of permissions.

RepositoryException - If there is any general repository problem.

PathNotFoundException

LockException

DatabaseException

getUpdateMessage

String getUpdateMessage(String token)
                        throws RepositoryException

Get the update message, if any.

Returns:

A possible update message or simple info for the application.

Throws:

RepositoryException - If there is any general repository problem.

getRepositoryUuid

String getRepositoryUuid(String token)
                         throws RepositoryException

Get the unique repository identifier

Returns:

The repository UUID

Throws:

RepositoryException - If there is any general repository problem.

hasNode

boolean hasNode(String token,
              String nodeId)
                throws RepositoryException,
                       DatabaseException

Test if a node path exists

Parameters:

nodeId - The path that identifies an unique document or its UUID.

Returns:

true if the node exist or false if not

Throws:

RepositoryException - If there is any general repository problem.

DatabaseException

getNodePath

String getNodePath(String token,
                 String uuid)
                   throws PathNotFoundException,
                          RepositoryException,
                          DatabaseException

Obtain the node path with a given uuid.

Parameters:

uuid - An unique node identifier

Returns:

The path of the node with the given uuid

Throws:

PathNotFoundException - If there is no user node in the repository with this uuid.

RepositoryException - If there is any general repository problem.

DatabaseException

getNodeUuid

String getNodeUuid(String token,
                 String path)
                   throws PathNotFoundException,
                          RepositoryException,
                          DatabaseException

Obtain the node uuid with a given path.

Parameters:

path - An unique path node identifier

Returns:

The path of the node with the given uuid

Throws:

PathNotFoundException - If there is no user node in the repository with this uuid.

RepositoryException - If there is any general repository problem.

DatabaseException

getAppVersion

AppVersion getAppVersion(String token)
                         throws RepositoryException,
                                DatabaseException

Retrieve application version.

Parameters:

token - Security token.

Returns:

Application version.

Throws:

RepositoryException

DatabaseException

copyAttributes

void copyAttributes(String token,
                  String srcId,
                  String dstId,
                  ExtendedAttributes extAttr)
                    throws AccessDeniedException,
                           PathNotFoundException,
                           DatabaseException

Copy attributes from a node to another.

Parameters:

token - Security token.

srcId - The path that identifies an unique document or its UUID.

dstId - The path that identifies an unique document or its UUID.

extAttr - Which attributes need to be copied.

Throws:

AccessDeniedException

PathNotFoundException

DatabaseException