Package com.openkm.sdk4j.definition

Interface BaseBookmark

All Known Implementing Classes:

BookmarkImpl

public interface BaseBookmark

BaseBookmark

Author:

sochoa

Method Summary

Modifier and Type	Method	Description
Bookmark	create(String uuid, String name)	Add a new bookmark which points to this document.
void	delete(long bookmarkId)	Remove a bookmark.
List<Bookmark>	getUserBookmarks()	Retrive an user bookmark collection.
void	rename(long bookmarkId, String name)	Rename a previous stored bookmark.

Method Detail

getUserBookmarks

List<Bookmark> getUserBookmarks()
                         throws AccessDeniedException,
                                RepositoryException,
                                DatabaseException,
                                WebserviceException,
                                UnknownException,
                                AuthException

Retrive an user bookmark collection.

Returns:

List All the user bookmarks.

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

WebserviceException - the webservice exception

UnknownException - the unknown exception

AuthException - the principal adapter exception

create

Bookmark create(String uuid,
                String name)
         throws LockException,
                PathNotFoundException,
                AccessDeniedException,
                RepositoryException,
                DatabaseException,
                WebserviceException,
                UnknownException,
                ItemExistsException

Add a new bookmark which points to this document.

Parameters:

uuid - Node uuid

name - The name of the bookmark.

Throws:

LockException - the lock exception

PathNotFoundException - the path not found exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

WebserviceException - the webservice exception

UnknownException - the unknown exception

ItemExistsException - the item exists exception

rename

void rename(long bookmarkId,
            String name)
     throws AccessDeniedException,
            RepositoryException,
            DatabaseException,
            WebserviceException,
            UnknownException,
            AuthException

Rename a previous stored bookmark.

Parameters:

bookmarkId - The actual bookmark id.

name - The new bookmark name.

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

WebserviceException - the webservice exception

UnknownException - the unknown exception

AuthException - the principal adapter exception

delete

void delete(long bookmarkId)
     throws AccessDeniedException,
            RepositoryException,
            DatabaseException,
            WebserviceException,
            UnknownException,
            AuthException

Remove a bookmark.

Parameters:

bookmarkId - The bookmark id to be deleted.

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

WebserviceException - the webservice exception

UnknownException - the unknown exception

AuthException - the principal adapter exception