com.openkm.module

Interface PropertyModule

All Known Implementing Classes:

DbPropertyModule, JcrPropertyModule, OKMProperty, PropertyService

public interface PropertyModule

Method Summary

Methods

Modifier and Type	Method and Description
void	addCategory(String token, String nodePath, String catId) Add a category to a node.
String	addKeyword(String token, String nodePath, String keyword) Add a keyword to a node.
void	removeCategory(String token, String nodePath, String catId) Remove a category from a node.
void	removeKeyword(String token, String nodePath, String keyword) Remove a keyword from a node.

Method Detail

addCategory

void addCategory(String token,
               String nodePath,
               String catId)
                 throws VersionException,
                        LockException,
                        PathNotFoundException,
                        AccessDeniedException,
                        RepositoryException,
                        DatabaseException

Add a category to a node.

Parameters:

token - The session authorization token.

nodePath - The complete path to the node.

catId - Category id (the UUID of the category node).

Throws:

VersionException - A document checked in can't be modified.

LockException - A locked document can't be modified.

PathNotFoundException - If there is no node in this repository path.

AccessDeniedException - If there is any security problem: you can't modify the node because of lack of permissions.

RepositoryException - If there is any general repository problem.

DatabaseException

removeCategory

void removeCategory(String token,
                  String nodePath,
                  String catId)
                    throws VersionException,
                           LockException,
                           PathNotFoundException,
                           AccessDeniedException,
                           RepositoryException,
                           DatabaseException

Remove a category from a node.

Parameters:

token - The session authorization token.

nodePath - The complete path to the node.

catId - Category id (the UUID of the category node).

Throws:

VersionException - A document checked in can't be modified.

LockException - A locked document can't be modified.

PathNotFoundException - If there is no node in this repository path.

AccessDeniedException - If there is any security problem: you can't modify the node because of lack of permissions.

RepositoryException - If there is any general repository problem.

DatabaseException

addKeyword

String addKeyword(String token,
                String nodePath,
                String keyword)
                  throws VersionException,
                         LockException,
                         PathNotFoundException,
                         AccessDeniedException,
                         RepositoryException,
                         DatabaseException

Add a keyword to a node.

Parameters:

token - The session authorization token.

nodePath - The complete path to the node.

keyword - The keyword to be added.

Throws:

VersionException - A document checked in can't be modified.

LockException - A locked document can't be modified.

PathNotFoundException - If there is no node in this repository path.

AccessDeniedException - If there is any security problem: you can't modify the node because of lack of permissions.

RepositoryException - If there is any general repository problem.

DatabaseException

removeKeyword

void removeKeyword(String token,
                 String nodePath,
                 String keyword)
                   throws VersionException,
                          LockException,
                          PathNotFoundException,
                          AccessDeniedException,
                          RepositoryException,
                          DatabaseException

Remove a keyword from a node.

Parameters:

token - The session authorization token.

nodePath - The complete path to the node.

keyword - The keyword to be removed.

Throws:

VersionException - A document checked in can't be modified.

LockException - A locked document can't be modified.

PathNotFoundException - If there is no node in this repository path.

AccessDeniedException - If there is any security problem: you can't modify the node because of lack of permissions.

RepositoryException - If there is any general repository problem.

DatabaseException