Package com.openkm.sdk4j.definition
Interface BaseBookmark
- All Known Implementing Classes:
BookmarkImpl
public interface BaseBookmark
BaseBookmark
- Author:
- sochoa
-
Method Summary
Modifier and TypeMethodDescriptionAdd a new bookmark which points to this document.voiddelete(long bookmarkId) Remove a bookmark.Retrive an user bookmark collection.voidRename a previous stored bookmark.
-
Method Details
-
getUserBookmarks
List<Bookmark> getUserBookmarks() throws AccessDeniedException, RepositoryException, DatabaseException, WebserviceException, UnknownException, AuthExceptionRetrive an user bookmark collection.- Returns:
- List
All the user bookmarks. - Throws:
AccessDeniedException- the access denied exceptionRepositoryException- the repository exceptionDatabaseException- the database exceptionWebserviceException- the webservice exceptionUnknownException- the unknown exceptionAuthException- 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 uuidname- The name of the bookmark.- Throws:
LockException- the lock exceptionPathNotFoundException- the path not found exceptionAccessDeniedException- the access denied exceptionRepositoryException- the repository exceptionDatabaseException- the database exceptionWebserviceException- the webservice exceptionUnknownException- the unknown exceptionItemExistsException- 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 exceptionRepositoryException- the repository exceptionDatabaseException- the database exceptionWebserviceException- the webservice exceptionUnknownException- the unknown exceptionAuthException- 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 exceptionRepositoryException- the repository exceptionDatabaseException- the database exceptionWebserviceException- the webservice exceptionUnknownException- the unknown exceptionAuthException- the principal adapter exception
-