Package com.logicaldoc.webservice.rest

Interface BookmarkService

All Known Implementing Classes:

RestBookmarkService, RestBookmarkSwagger

@Consumes({"application/xml","application/json"})
@Produces("application/json")
public interface BookmarkService

Bookmark Web Service definition interface for REST Marco Meschieri - LogicalDOC

Since:

7.6.3

Method Summary

Modifier and Type	Method	Description
WSBookmark	bookmarkDocument(long docId)
WSBookmark	bookmarkFolder(long folderId)
void	deleteBookmark(long bookmarkId)
WSBookmark[]	getBookmarks()
WSBookmark	saveBookmark(WSBookmark bookmark)
void	unbookmarkDocument(long docId)
void	unbookmarkFolder(long folderId)

Method Details

saveBookmark

@POST
@Path("/saveBookmark")
WSBookmark saveBookmark(WSBookmark bookmark)
                 throws AuthenticationException,
PermissionException,
WebserviceException,
PersistenceException,
UnexistingResourceException

Throws:

AuthenticationException

PermissionException

WebserviceException

PersistenceException

UnexistingResourceException

bookmarkDocument

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

Throws:

AuthenticationException

PermissionException

WebserviceException

PersistenceException

UnexistingResourceException

bookmarkFolder

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

Throws:

AuthenticationException

PermissionException

WebserviceException

PersistenceException

getBookmarks

@GET
@Path("/getBookmarks")
WSBookmark[] getBookmarks()
                   throws AuthenticationException,
PermissionException,
WebserviceException,
PersistenceException

Throws:

AuthenticationException

PermissionException

WebserviceException

PersistenceException

deleteBookmark

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

Throws:

AuthenticationException

PermissionException

WebserviceException

PersistenceException

unbookmarkDocument

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

Throws:

AuthenticationException

PermissionException

WebserviceException

PersistenceException

unbookmarkFolder

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

Throws:

AuthenticationException

PermissionException

WebserviceException

PersistenceException