com.openkm.module

Interface BookmarkModule

All Known Implementing Classes:

DbBookmarkModule, JcrBookmarkModule, OKMBookmark

public interface BookmarkModule

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.
void	remove(String token, int bmId) Remove a bookmark.
Bookmark	rename(String token, int bmId, String newName) Rename a previous stored bookmark.

Method Detail

add

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

Add a new bookmark which points to this document.

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

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

Get info from a previously created bookmark.

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

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

Remove a bookmark.

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

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

Rename a previous stored bookmark.

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

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

Retrive an user bookmark collection.

Parameters:

token - The session authorization token.

Returns:

All the user bookmarks.

Throws:

RepositoryException - If there is any general repository problem.

DatabaseException