Package com.logicaldoc.webservice.rest.client

Class RestBookmarkClient

java.lang.Object

com.logicaldoc.webservice.rest.client.AbstractRestClient

com.logicaldoc.webservice.rest.client.RestBookmarkClient

public class RestBookmarkClient
extends AbstractRestClient

Constructor Summary

Constructors

Constructor	Description
RestBookmarkClient(String endpoint, String username, String password)
RestBookmarkClient(String endpoint, String username, String password, int timeout)

Method Summary

Modifier and Type	Method	Description
WSBookmark	bookmarkDocument(long docId)
WSBookmark	bookmarkFolder(long folderId)
void	deleteBookmark(long bookmarkId)
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 Detail

RestBookmarkClient

public RestBookmarkClient(String endpoint,
                          String username,
                          String password)

RestBookmarkClient

public RestBookmarkClient(String endpoint,
                          String username,
                          String password,
                          int timeout)

Method Detail

saveBookmark

public WSBookmark saveBookmark(WSBookmark bookmark)
                        throws Exception

Throws:

Exception

bookmarkDocument

public WSBookmark bookmarkDocument(@QueryParam("docId")
                                   long docId)
                            throws Exception

Throws:

Exception

bookmarkFolder

@GET
@Path("/bookmarkFolder")
public WSBookmark bookmarkFolder(@QueryParam("folderId")
                                 long folderId)
                          throws Exception

Throws:

Exception

getBookmarks

@GET
@Path("/getBookmarks")
public WSBookmark[] getBookmarks()
                          throws Exception

Retrieves all the bookmarks of the current user

Returns:

array of bookmarks

Throws:

Exception - error in the server application

deleteBookmark

@DELETE
@Path("/deleteBookmark")
public void deleteBookmark(@QueryParam("bookmarkId")
                           long bookmarkId)
                    throws Exception

Throws:

Exception

unbookmarkDocument

@DELETE
@Path("/unbookmarkDocument")
public void unbookmarkDocument(@QueryParam("docId")
                               long docId)
                        throws Exception

Throws:

Exception

unbookmarkFolder

@DELETE
@Path("/unbookmarkFolder")
public void unbookmarkFolder(@QueryParam("folderId")
                             long folderId)
                      throws Exception

Throws:

Exception