public class OKMProperty extends Object implements PropertyModule
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.
|
public static OKMProperty getInstance()
public void addCategory(String token, String nodeId, String catId) throws VersionException, LockException, PathNotFoundException, AccessDeniedException, RepositoryException, DatabaseException
PropertyModule
addCategory
in interface PropertyModule
token
- The session authorization token.nodeId
- The complete path to the node.catId
- Category id (the UUID of the category node).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
public void removeCategory(String token, String nodeId, String catId) throws VersionException, LockException, PathNotFoundException, AccessDeniedException, RepositoryException, DatabaseException
PropertyModule
removeCategory
in interface PropertyModule
token
- The session authorization token.nodeId
- The complete path to the node.catId
- Category id (the UUID of the category node).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
public String addKeyword(String token, String nodeId, String keyword) throws VersionException, LockException, PathNotFoundException, AccessDeniedException, RepositoryException, DatabaseException
PropertyModule
addKeyword
in interface PropertyModule
token
- The session authorization token.nodeId
- The complete path to the node.keyword
- The keyword to be added.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
public void removeKeyword(String token, String nodeId, String keyword) throws VersionException, LockException, PathNotFoundException, AccessDeniedException, RepositoryException, DatabaseException
PropertyModule
removeKeyword
in interface PropertyModule
token
- The session authorization token.nodeId
- The complete path to the node.keyword
- The keyword to be removed.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
public void setEncryption(String token, String nodePath, String cipherName) throws VersionException, LockException, PathNotFoundException, AccessDeniedException, RepositoryException, DatabaseException
PropertyModule
setEncryption
in interface PropertyModule
token
- The session authorization token.nodePath
- The complete path to the node.cipherName
- The cipher used in the encryption.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
public void unsetEncryption(String token, String nodePath) throws VersionException, LockException, PathNotFoundException, AccessDeniedException, RepositoryException, DatabaseException
PropertyModule
unsetEncryption
in interface PropertyModule
token
- The session authorization token.nodePath
- The complete path to the node.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
public void setSigned(String token, String nodePath, boolean signed) throws VersionException, LockException, PathNotFoundException, AccessDeniedException, RepositoryException, DatabaseException
PropertyModule
setSigned
in interface PropertyModule
token
- The session authorization token.nodePath
- The complete path to the node.signed
- If the document is signed or notVersionException
- 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
Copyright © 2019 Open Knowledge Management System S.L.. All rights reserved.