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

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.
static OKMProperty	getInstance()
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.

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 nodePath,
               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.

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

public void removeCategory(String token,
                  String nodePath,
                  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.

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

public String addKeyword(String token,
                String nodePath,
                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.

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

public void removeKeyword(String token,
                 String nodePath,
                 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.

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