Package com.logicaldoc.webservice.soap.client

Class SoapBookmarkClient

java.lang.Object

com.logicaldoc.webservice.soap.client.SoapClient<BookmarkService>

com.logicaldoc.webservice.soap.client.SoapBookmarkClient

All Implemented Interfaces:

BookmarkService

public class SoapBookmarkClient
extends SoapClient<BookmarkService>
implements BookmarkService

Bookmark Web Service client.

Since:

7.6.3

Author:

Marco Meschieri - LogicalDOC

Constructor Summary

Constructors

Constructor	Description
SoapBookmarkClient(String endpoint)
SoapBookmarkClient(String endpoint, int gzipThreshold, boolean log, int timeout)

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)
List<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)

Methods inherited from class java.lang.Object

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

Constructor Details

SoapBookmarkClient

public SoapBookmarkClient(String endpoint,
 int gzipThreshold,
 boolean log,
 int timeout)

SoapBookmarkClient

public SoapBookmarkClient(String endpoint)

Method Details

saveBookmark

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

Specified by:

saveBookmark in interface BookmarkService

Throws:

AuthenticationException

PermissionException

WebserviceException

PersistenceException

UnexistingResourceException

bookmarkDocument

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

Specified by:

bookmarkDocument in interface BookmarkService

Throws:

AuthenticationException

PermissionException

WebserviceException

PersistenceException

UnexistingResourceException

bookmarkFolder

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

Specified by:

bookmarkFolder in interface BookmarkService

Throws:

AuthenticationException

PermissionException

WebserviceException

PersistenceException

getBookmarks

public List<WSBookmark> getBookmarks(String sid)
                              throws AuthenticationException,
WebserviceException,
PersistenceException

Description copied from interface: BookmarkService

Retrieves all the bookmarks of the current user

Specified by:

getBookmarks in interface BookmarkService

Parameters:

sid - identifier of the session or an API Key

Returns:

list of bookmarks

Throws:

AuthenticationException - Invalid session

WebserviceException - Error in the webservice

PersistenceException - Error in the database

deleteBookmark

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

Specified by:

deleteBookmark in interface BookmarkService

Throws:

AuthenticationException

WebserviceException

PersistenceException

unbookmarkDocument

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

Specified by:

unbookmarkDocument in interface BookmarkService

Throws:

AuthenticationException

WebserviceException

PersistenceException

unbookmarkFolder

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

Specified by:

unbookmarkFolder in interface BookmarkService

Throws:

AuthenticationException

WebserviceException

PersistenceException