public interface NoteModule
Modifier and Type | Method and Description |
---|---|
Note |
add(String token,
String nodePath,
String text)
Add a note to a document
|
void |
delete(String token,
String notePath)
Remove a note from a document
|
Note |
get(String token,
String notePath)
Get note from document
|
List<Note> |
list(String token,
String nodePath)
Retrieve a list of notes from a document.
|
String |
set(String token,
String notePath,
String text)
Set a new text to document note.
|
Note add(String token, String nodePath, String text) throws LockException, PathNotFoundException, AccessDeniedException, RepositoryException, DatabaseException
token
- The session authorization token.nodePath
- The path that identifies an unique document.text
- The message textLockException
- A locked document can't be modified.PathNotFoundException
- If there is no document in the repository with this path.AccessDeniedException
- If there is any security problem:
you can't access this document because of lack of permissions.RepositoryException
- If there is any general repository problem.DatabaseException
void delete(String token, String notePath) throws LockException, PathNotFoundException, AccessDeniedException, RepositoryException, DatabaseException
token
- The session authorization token.notePath
- The path that identifies an unique document note.LockException
- A locked document can't be modified.PathNotFoundException
- If there is no document in the repository with this path.AccessDeniedException
- If there is any security problem:
you can't access this document because of lack of permissions.RepositoryException
- If there is any general repository problem.DatabaseException
Note get(String token, String notePath) throws LockException, PathNotFoundException, AccessDeniedException, RepositoryException, DatabaseException
token
- The session authorization token.notePath
- The path that identifies an unique document note.LockException
- A locked document can't be modified.PathNotFoundException
- If there is no document in the repository with this path.AccessDeniedException
- If there is any security problem:
you can't access this document because of lack of permissions.RepositoryException
- If there is any general repository problem.DatabaseException
String set(String token, String notePath, String text) throws LockException, PathNotFoundException, AccessDeniedException, RepositoryException, DatabaseException
token
- The session authorization token.notePath
- The path that identifies an unique document note.text
- The message textLockException
- A locked document can't be modified.PathNotFoundException
- If there is no document in the repository with this path.AccessDeniedException
- If there is any security problem:
you can't access this document because of lack of permissions.RepositoryException
- If there is any general repository problem.DatabaseException
List<Note> list(String token, String nodePath) throws AccessDeniedException, PathNotFoundException, RepositoryException, DatabaseException
token
- The session authorization token.nodePath
- The path that identifies an unique document.PathNotFoundException
- If there is no document in this repository path.RepositoryException
- If there is any general repository problem.AccessDeniedException
DatabaseException
Copyright © 2019 Open Knowledge Management System S.L.. All rights reserved.