com.openkm.module

Interface NoteModule

All Known Implementing Classes:

DbNoteModule, OKMNote

public interface NoteModule

Method Summary

Methods

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.

Method Detail

add

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

Add a note to a document

Parameters:

token - The session authorization token.

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

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

Remove a note from a document

Parameters:

token - The session authorization token.

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

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

Get note from document

Parameters:

token - The session authorization token.

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

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

Set a new text to document note.

Parameters:

token - The session authorization token.

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

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

Retrieve a list of notes from a document.

Parameters:

token - The session authorization token.

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