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 Exception

Throws:

Exception

bookmarkDocument

WSBookmark bookmarkDocument(String sid,
                            long docId)
                     throws Exception

Throws:

Exception

bookmarkFolder

WSBookmark bookmarkFolder(String sid,
                          long folderId)
                   throws Exception

Throws:

Exception

getBookmarks

WSBookmark[] getBookmarks(String sid)
                   throws Exception

Retrieves all the bookmarks of the current user

Parameters:

sid - identifier of the session

Returns:

array of bookmarks

Throws:

Exception - error in the server application

deleteBookmark

void deleteBookmark(String sid,
                    long bookmarkId)
             throws Exception

Throws:

Exception

unbookmarkDocument

void unbookmarkDocument(String sid,
                        long docId)
                 throws Exception

Throws:

Exception

unbookmarkFolder

void unbookmarkFolder(String sid,
                      long folderId)
               throws Exception

Throws:

Exception