Package com.logicaldoc.webservice.soap

Interface BookmarkService

All Known Implementing Classes:

RestBookmarkService, RestBookmarkSwagger, SoapBookmarkClient, SoapBookmarkService

public interface BookmarkService

Bookmark Web Service definition interface Marco Meschieri - LogicalDOC

Since:

7.6.3

Method Summary

Modifier and Type	Method	Description
WSBookmark	bookmarkDocument(String sid, long docId)
WSBookmark	bookmarkFolder(String sid, long folderId)
void	deleteBookmark(String sid, long bookmarkId)
WSBookmark[]	getBookmarks(String sid)	Retrieves all the bookmarks of the current user
WSBookmark	saveBookmark(String sid, WSBookmark bookmark)
void	unbookmarkDocument(String sid, long docId)
void	unbookmarkFolder(String sid, long folderId)

Method Detail

saveBookmark

WSBookmark saveBookmark(String sid,
                        WSBookmark bookmark)
                 throws AuthenticationException,
                        WebserviceException,
                        PersistenceException,
                        PermissionException

Throws:

AuthenticationException

WebserviceException

PersistenceException

PermissionException

bookmarkDocument

WSBookmark bookmarkDocument(String sid,
                            long docId)
                     throws AuthenticationException,
                            WebserviceException,
                            PersistenceException,
                            PermissionException

Throws:

AuthenticationException

WebserviceException

PersistenceException

PermissionException

bookmarkFolder

WSBookmark bookmarkFolder(String sid,
                          long folderId)
                   throws AuthenticationException,
                          PermissionException,
                          WebserviceException,
                          PersistenceException

Throws:

AuthenticationException

PermissionException

WebserviceException

PersistenceException

getBookmarks

WSBookmark[] getBookmarks(String sid)
                   throws AuthenticationException,
                          WebserviceException,
                          PersistenceException

Retrieves all the bookmarks of the current user

Parameters:

sid - identifier of the session

Returns:

array of bookmarks

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

deleteBookmark

void deleteBookmark(String sid,
                    long bookmarkId)
             throws AuthenticationException,
                    WebserviceException,
                    PersistenceException

Throws:

AuthenticationException

WebserviceException

PersistenceException

unbookmarkDocument

void unbookmarkDocument(String sid,
                        long docId)
                 throws AuthenticationException,
                        WebserviceException,
                        PersistenceException

Throws:

AuthenticationException

WebserviceException

PersistenceException

unbookmarkFolder

void unbookmarkFolder(String sid,
                      long folderId)
               throws AuthenticationException,
                      WebserviceException,
                      PersistenceException

Throws:

AuthenticationException

WebserviceException

PersistenceException