Package com.openkm.sdk4j.definition

Interface BaseNote

All Known Implementing Classes:

NoteImpl

public interface BaseNote

BaseNote

Author:

sochoa

Method Summary

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

Method Detail

add

Note add(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

get

Note get(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

delete

void delete(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

set

void set(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

list

List<Note> list(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

getNoteHistories

List<NoteHistory> getNoteHistories(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