com.openkm.sdk4j.definition

Interface BaseNote

All Known Implementing Classes:

NoteImpl, OKMWebservices

public interface BaseNote

BaseNote

Author:

jllort

Method Summary

Modifier and Type	Method and Description
Note	addNote(String uuid, String text) Add a note to a node
void	deleteNote(String noteId) Remove a note from a node
Note	getNote(String nodeId) Get note from node
List<NoteHistory>	getNotesHistory(String uuid) Retrieve a list of notes history from a node
List<Note>	listNotes(String uuid) Retrieve a list of notes from a node.
void	setNote(String noteId, String text) Set a new text to node note.

Method Detail

addNote

Note addNote(String uuid,
             String text)
      throws LockException,
             PathNotFoundException,
             AccessDeniedException,
             RepositoryException,
             DatabaseException,
             UnknownException,
             WebserviceException

Add a note to a node

Parameters:

uuid - Node uuid

text - The message text

Returns:

Note A note object with the new created note properties.

Throws:

LockException - the lock exception

PathNotFoundException - the path not found exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

getNote

Note getNote(String nodeId)
      throws LockException,
             PathNotFoundException,
             AccessDeniedException,
             RepositoryException,
             DatabaseException,
             UnknownException,
             WebserviceException

Get note from node

Parameters:

nodeId - Node uuid

Returns:

Note The required note associated to the node.

Throws:

LockException - the lock exception

PathNotFoundException - the path not found exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

deleteNote

void deleteNote(String noteId)
         throws LockException,
                PathNotFoundException,
                AccessDeniedException,
                RepositoryException,
                DatabaseException,
                UnknownException,
                WebserviceException

Remove a note from a node

Parameters:

noteId - Node uuid

Throws:

LockException - the lock exception

PathNotFoundException - the path not found exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

setNote

void setNote(String noteId,
             String text)
      throws LockException,
             PathNotFoundException,
             AccessDeniedException,
             RepositoryException,
             DatabaseException,
             UnknownException,
             WebserviceException

Set a new text to node note.

Parameters:

noteId - Node uuid

text - The message text

Throws:

LockException - the lock exception

PathNotFoundException - the path not found exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

listNotes

List<Note> listNotes(String uuid)
              throws PathNotFoundException,
                     RepositoryException,
                     DatabaseException,
                     UnknownException,
                     WebserviceException

Retrieve a list of notes from a node.

Parameters:

uuid - Node uuid

Returns:

List A Collection with the node notes.

Throws:

PathNotFoundException - the path not found exception

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

getNotesHistory

List<NoteHistory> getNotesHistory(String uuid)
                           throws PathNotFoundException,
                                  RepositoryException,
                                  DatabaseException,
                                  UnknownException,
                                  WebserviceException

Retrieve a list of notes history from a node

Parameters:

uuid - Node uuid

Returns:

List A Collection with the notes history.

Throws:

PathNotFoundException - the path not found exception

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception