com.openkm.api

Class OKMProperty

java.lang.Object

com.openkm.api.OKMProperty

All Implemented Interfaces:

PropertyModule

public class OKMProperty
extends Object
implements PropertyModule

Author:

pavila

Method Summary

Modifier and Type	Method and Description
void	addCategory(String token, String nodeId, String catId) Add a category to a node.
String	addKeyword(String token, String nodeId, String keyword) Add a keyword to a node.
static OKMProperty	getInstance()
void	removeCategory(String token, String nodeId, String catId) Remove a category from a node.
void	removeKeyword(String token, String nodeId, String keyword) Remove a keyword from a node.
void	setEncryption(String token, String nodePath, String cipherName) Define a document as encrypted.
void	setSigned(String token, String nodePath, boolean signed) Define a document as signed.
void	unsetEncryption(String token, String nodePath) Unset a document as encrypted.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getInstance

public static OKMProperty getInstance()

addCategory

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

Description copied from interface: PropertyModule

Add a category to a node.

Specified by:

addCategory in interface PropertyModule

Parameters:

token - The session authorization token.

nodeId - 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

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

Description copied from interface: PropertyModule

Remove a category from a node.

Specified by:

removeCategory in interface PropertyModule

Parameters:

token - The session authorization token.

nodeId - 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

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

Description copied from interface: PropertyModule

Add a keyword to a node.

Specified by:

addKeyword in interface PropertyModule

Parameters:

token - The session authorization token.

nodeId - 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

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

Description copied from interface: PropertyModule

Remove a keyword from a node.

Specified by:

removeKeyword in interface PropertyModule

Parameters:

token - The session authorization token.

nodeId - 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

setEncryption

public void setEncryption(String token,
                          String nodePath,
                          String cipherName)
                   throws VersionException,
                          LockException,
                          PathNotFoundException,
                          AccessDeniedException,
                          RepositoryException,
                          DatabaseException

Description copied from interface: PropertyModule

Define a document as encrypted.

Specified by:

setEncryption in interface PropertyModule

Parameters:

token - The session authorization token.

nodePath - The complete path to the node.

cipherName - The cipher used in the encryption.

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

unsetEncryption

public void unsetEncryption(String token,
                            String nodePath)
                     throws VersionException,
                            LockException,
                            PathNotFoundException,
                            AccessDeniedException,
                            RepositoryException,
                            DatabaseException

Description copied from interface: PropertyModule

Unset a document as encrypted.

Specified by:

unsetEncryption in interface PropertyModule

Parameters:

token - The session authorization token.

nodePath - The complete path to the 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

setSigned

public void setSigned(String token,
                      String nodePath,
                      boolean signed)
               throws VersionException,
                      LockException,
                      PathNotFoundException,
                      AccessDeniedException,
                      RepositoryException,
                      DatabaseException

Description copied from interface: PropertyModule

Define a document as signed.

Specified by:

setSigned in interface PropertyModule

Parameters:

token - The session authorization token.

nodePath - The complete path to the node.

signed - If the document is signed or not

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