com.openkm.module.db

Class DbNoteModule

java.lang.Object

com.openkm.module.db.DbNoteModule

All Implemented Interfaces:

NoteModule

public class DbNoteModule
extends Object
implements NoteModule

Constructor Summary

Constructors

Constructor and Description
DbNoteModule()

Method Summary

Modifier and Type	Method and Description
Note	add(String token, String nodeId, String text) Add a note to a document
void	delete(String token, String noteId) Remove a note from a document
Note	get(String token, String noteId) Get note from document
List<Note>	list(String token, String nodeId) Retrieve a list of notes from a document.
String	set(String token, String noteId, String text) Set a new text to document note.

Methods inherited from class java.lang.Object

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

Constructor Detail

DbNoteModule

public DbNoteModule()

Method Detail

add

public Note add(String token,
                String nodeId,
                String text)
         throws LockException,
                PathNotFoundException,
                AccessDeniedException,
                RepositoryException,
                DatabaseException

Description copied from interface: NoteModule

Add a note to a document

Specified by:

add in interface NoteModule

Parameters:

token - The session authorization token.

nodeId - The path that identifies an unique document.

text - The message text

Returns:

A note object with the new created note properties.

Throws:

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

delete

public void delete(String token,
                   String noteId)
            throws LockException,
                   PathNotFoundException,
                   AccessDeniedException,
                   RepositoryException,
                   DatabaseException

Description copied from interface: NoteModule

Remove a note from a document

Specified by:

delete in interface NoteModule

Parameters:

token - The session authorization token.

noteId - The path that identifies an unique document note.

Throws:

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

get

public Note get(String token,
                String noteId)
         throws LockException,
                PathNotFoundException,
                AccessDeniedException,
                RepositoryException,
                DatabaseException

Description copied from interface: NoteModule

Get note from document

Specified by:

get in interface NoteModule

Parameters:

token - The session authorization token.

noteId - The path that identifies an unique document note.

Returns:

The required note associated to the document.

Throws:

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

set

public String set(String token,
                  String noteId,
                  String text)
           throws LockException,
                  PathNotFoundException,
                  AccessDeniedException,
                  RepositoryException,
                  DatabaseException

Description copied from interface: NoteModule

Set a new text to document note.

Specified by:

set in interface NoteModule

Parameters:

token - The session authorization token.

noteId - The path that identifies an unique document note.

text - The message text

Throws:

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

list

public List<Note> list(String token,
                       String nodeId)
                throws AccessDeniedException,
                       PathNotFoundException,
                       RepositoryException,
                       DatabaseException

Description copied from interface: NoteModule

Retrieve a list of notes from a document.

Specified by:

list in interface NoteModule

Parameters:

token - The session authorization token.

nodeId - The path that identifies an unique document.

Returns:

A Collection with the document notes.

Throws:

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

RepositoryException - If there is any general repository problem.

AccessDeniedException

DatabaseException