Package com.logicaldoc.webservice.rest.client

Class RestBookmarkClient

java.lang.Object

com.logicaldoc.webservice.rest.client.AbstractRestClient<BookmarkService>

com.logicaldoc.webservice.rest.client.RestBookmarkClient

public class RestBookmarkClient
extends AbstractRestClient<BookmarkService>

Constructor Summary

Constructors

Constructor	Description
RestBookmarkClient(String endpoint, String apiKey)
RestBookmarkClient(String endpoint, String apiKey, int timeout)

Method Summary

Modifier and Type	Method	Description
WSBookmark	bookmarkDocument(long docId)
WSBookmark	bookmarkFolder(long folderId)
void	deleteBookmark(long bookmarkId)
List<WSBookmark>	getBookmarks()	Retrieves all the bookmarks of the current user
WSBookmark	saveBookmark(WSBookmark bookmark)
void	unbookmarkDocument(long docId)
void	unbookmarkFolder(long folderId)

Methods inherited from class java.lang.Object

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

Constructor Details

RestBookmarkClient

public RestBookmarkClient(String endpoint,
 String apiKey)

RestBookmarkClient

public RestBookmarkClient(String endpoint,
 String apiKey,
 int timeout)

Method Details

saveBookmark

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

Throws:

AuthenticationException

PermissionException

WebserviceException

PersistenceException

UnexistingResourceException

bookmarkDocument

public WSBookmark bookmarkDocument(@QueryParam("docId")
 long docId)
                            throws AuthenticationException,
PermissionException,
WebserviceException,
PersistenceException,
UnexistingResourceException

Throws:

AuthenticationException

PermissionException

WebserviceException

PersistenceException

UnexistingResourceException

bookmarkFolder

@GET
@Path("/bookmarkFolder")
public WSBookmark bookmarkFolder(@QueryParam("folderId")
 long folderId)
                          throws AuthenticationException,
PermissionException,
WebserviceException,
PersistenceException

Throws:

AuthenticationException

PermissionException

WebserviceException

PersistenceException

getBookmarks

@GET
@Path("/getBookmarks")
public List<WSBookmark> getBookmarks()
                              throws AuthenticationException,
PermissionException,
WebserviceException,
PersistenceException

Retrieves all the bookmarks of the current user

Returns:

list of bookmarks

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

PermissionException - The user does not have the required permission

deleteBookmark

@DELETE
@Path("/deleteBookmark")
public void deleteBookmark(@QueryParam("bookmarkId")
 long bookmarkId)
                    throws AuthenticationException,
PermissionException,
WebserviceException,
PersistenceException

Throws:

AuthenticationException

PermissionException

WebserviceException

PersistenceException

unbookmarkDocument

@DELETE
@Path("/unbookmarkDocument")
public void unbookmarkDocument(@QueryParam("docId")
 long docId)
                        throws AuthenticationException,
PermissionException,
WebserviceException,
PersistenceException

Throws:

AuthenticationException

PermissionException

WebserviceException

PersistenceException

unbookmarkFolder

@DELETE
@Path("/unbookmarkFolder")
public void unbookmarkFolder(@QueryParam("folderId")
 long folderId)
                      throws AuthenticationException,
PermissionException,
WebserviceException,
PersistenceException

Throws:

AuthenticationException

PermissionException

WebserviceException

PersistenceException