com.openkm.api

Class OKMBookmark

java.lang.Object

com.openkm.api.OKMBookmark

All Implemented Interfaces:

BookmarkModule

public class OKMBookmark
extends Object
implements BookmarkModule

Author:

pavila

Method Summary

Methods

Modifier and Type	Method and Description
Bookmark	add(String token, String nodePath, String name) Add a new bookmark which points to this document.
Bookmark	get(String token, int bmId) Get info from a previously created bookmark.
List<Bookmark>	getAll(String token) Retrive an user bookmark collection.
static OKMBookmark	getInstance()
void	remove(String token, int bmId) Remove a bookmark.
Bookmark	rename(String token, int bmId, String newName) Rename a previous stored bookmark.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static OKMBookmark getInstance()

add

public Bookmark add(String token,
           String nodePath,
           String name)
             throws AccessDeniedException,
                    PathNotFoundException,
                    RepositoryException,
                    DatabaseException

Description copied from interface: BookmarkModule

Add a new bookmark which points to this document.

Specified by:

add in interface BookmarkModule

Parameters:

token - The session authorization token.

nodePath - A node path to be bookmarked.

name - The name of the bookmark.

Returns:

A bookmark object with the new created bookmark properties.

Throws:

AccessDeniedException - If there is any security problem: you can't modify the node because of lack of permissions.

RepositoryException - If there is any general repository problem.

PathNotFoundException

DatabaseException

get

public Bookmark get(String token,
           int bmId)
             throws AccessDeniedException,
                    RepositoryException,
                    DatabaseException

Description copied from interface: BookmarkModule

Get info from a previously created bookmark.

Specified by:

get in interface BookmarkModule

Parameters:

token - The session authorization token.

bmId - The unique bookmark id.

Returns:

The bookmark object.

Throws:

AccessDeniedException - If there is any security problem: you can't modify the node because of lack of permissions.

RepositoryException - If there is any general repository problem.

DatabaseException

remove

public void remove(String token,
          int bmId)
            throws AccessDeniedException,
                   RepositoryException,
                   DatabaseException

Description copied from interface: BookmarkModule

Remove a bookmark.

Specified by:

remove in interface BookmarkModule

Parameters:

token - The session authorization token.

bmId - The bookmark id to be deleted.

Throws:

AccessDeniedException - If there is any security problem: you can't modify the node because of lack of permissions.

RepositoryException - If there is any general repository problem.

DatabaseException

rename

public Bookmark rename(String token,
              int bmId,
              String newName)
                throws AccessDeniedException,
                       RepositoryException,
                       DatabaseException

Description copied from interface: BookmarkModule

Rename a previous stored bookmark.

Specified by:

rename in interface BookmarkModule

Parameters:

token - The session authorization token.

bmId - The actual bookmark id.

newName - The new bookmark name.

Returns:

The updated bookmark properties.

Throws:

AccessDeniedException - If there is any security problem: you can't modify the node because of lack of permissions.

RepositoryException - If there is any general repository problem.

DatabaseException

getAll

public List<Bookmark> getAll(String token)
                      throws AccessDeniedException,
                             RepositoryException,
                             DatabaseException

Description copied from interface: BookmarkModule

Retrive an user bookmark collection.

Specified by:

getAll in interface BookmarkModule

Parameters:

token - The session authorization token.

Returns:

All the user bookmarks.

Throws:

RepositoryException - If there is any general repository problem.

AccessDeniedException

DatabaseException