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 TypeMethodDescriptionbookmarkDocument(String sid, long docId) bookmarkFolder(String sid, long folderId) voiddeleteBookmark(String sid, long bookmarkId) getBookmarks(String sid) Retrieves all the bookmarks of the current usersaveBookmark(String sid, WSBookmark bookmark) voidunbookmarkDocument(String sid, long docId) voidunbookmarkFolder(String sid, long folderId)
-
Method Details
-
saveBookmark
WSBookmark saveBookmark(String sid, WSBookmark bookmark) throws AuthenticationException, WebserviceException, PersistenceException, PermissionException, UnexistingResourceException -
bookmarkDocument
WSBookmark bookmarkDocument(String sid, long docId) throws AuthenticationException, WebserviceException, PersistenceException, PermissionException, UnexistingResourceException -
bookmarkFolder
WSBookmark bookmarkFolder(String sid, long folderId) throws AuthenticationException, PermissionException, WebserviceException, PersistenceException -
getBookmarks
List<WSBookmark> getBookmarks(String sid) throws AuthenticationException, WebserviceException, PersistenceException Retrieves all the bookmarks of the current user- Parameters:
sid- identifier of the session or an API Key- Returns:
- list of bookmarks
- Throws:
PersistenceException- Error in the databaseWebserviceException- Error in the webserviceAuthenticationException- Invalid session
-
deleteBookmark
void deleteBookmark(String sid, long bookmarkId) throws AuthenticationException, WebserviceException, PersistenceException -
unbookmarkDocument
void unbookmarkDocument(String sid, long docId) throws AuthenticationException, WebserviceException, PersistenceException -
unbookmarkFolder
void unbookmarkFolder(String sid, long folderId) throws AuthenticationException, WebserviceException, PersistenceException
-