Package com.openkm.sdk4j.impl

Class NoteImpl

java.lang.Object

com.openkm.sdk4j.impl.ClientImpl

com.openkm.sdk4j.impl.NoteImpl

All Implemented Interfaces:

BaseNote, Serializable

public class NoteImpl
extends ClientImpl
implements BaseNote, Serializable

NoteImpl

Author:

sochoa

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
NoteImpl(String host)	NoteImpl

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 noteId)	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.
protected void	setAuthorizationToken(String authorizationToken)	setAuthenticationToken

Methods inherited from class com.openkm.sdk4j.impl.ClientImpl

getClient, getWebTarget, setAuthorizationHeader, setJsessionIdHeader

Methods inherited from class java.lang.Object

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

Constructor Details

NoteImpl

public NoteImpl(String host)

NoteImpl

Method Details

setAuthorizationToken

protected void setAuthorizationToken(String authorizationToken)

setAuthenticationToken

add

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

Description copied from interface: BaseNote

Add a note to a node

Specified by:

add in interface BaseNote

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

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

Description copied from interface: BaseNote

Get note from node

Specified by:

get in interface BaseNote

Parameters:

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

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

Description copied from interface: BaseNote

Remove a note from a node

Specified by:

delete in interface BaseNote

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

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

Description copied from interface: BaseNote

Set a new text to node note.

Specified by:

set in interface BaseNote

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

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

Description copied from interface: BaseNote

Retrieve a list of notes from a node.

Specified by:

list in interface BaseNote

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

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

Description copied from interface: BaseNote

Retrieve a list of notes history from a node

Specified by:

getNoteHistories in interface BaseNote

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