com.openkm.api

Class OKMNote

java.lang.Object

com.openkm.api.OKMNote

All Implemented Interfaces:

NoteModule

public class OKMNote
extends Object
implements NoteModule

Author:

pavila

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

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static OKMNote getInstance()

add

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

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

get

public Note get(String token,
       String notePath)
         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.

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

delete

public void delete(String token,
          String notePath)
            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.

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

set

public String set(String token,
         String notePath,
         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.

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

public List<Note> list(String token,
              String nodePath)
                throws 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.

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.

DatabaseException