Package com.logicaldoc.enterprise.webservice.rest

Interface ReadingRequestService

All Known Implementing Classes:

RestReadingRequestService

@Consumes("application/json")
@Produces("application/json")
public interface ReadingRequestService

Enterprise Document Web Service definition interface

Since:

8.7.4

Author:

Alessandro Gasparini - LogicalDOC

Method Summary

Modifier and Type	Method	Description
void	askReadingConfirmation(List<Long> docIds, List<Long> userIds, List<Long> groupIds, boolean alertConfirmation, String comment)	Asks some users to confirm the reading of a set of documents
void	confirmReading(long readingId, String version)	Confirms a reading request
List<WSReadingRequest>	getUnconfirmedReadings()	Gets the list of all the unconfirmed readings requested to the current user

Method Details

askReadingConfirmation

@Consumes("application/x-www-form-urlencoded")
@POST
@Path("/askReadingConfirmation")
void askReadingConfirmation(@FormParam("docIds")
 List<Long> docIds,
 @FormParam("userIds")
 List<Long> userIds,
 @FormParam("groupIds")
 List<Long> groupIds,
 @FormParam("alertConfirmation")
 boolean alertConfirmation,
 @FormParam("comment")
 String comment)
                     throws com.logicaldoc.core.security.authentication.AuthenticationException,
com.logicaldoc.webservice.WebserviceException,
com.logicaldoc.core.PersistenceException,
IOException

Asks some users to confirm the reading of a set of documents

Parameters:

docIds - identifiers of the documents

userIds - identifiers of the recipient users

groupIds - identifiers of the recipient groups

alertConfirmation - if the requestor must be notified on reading confirmation

comment - an optional message to include in the notification

Throws:

IOException - I/O error

com.logicaldoc.core.PersistenceException - Error in the database layer

com.logicaldoc.webservice.WebserviceException - Error in the webservice logic

com.logicaldoc.core.security.authentication.AuthenticationException - The user was not authenticated

confirmReading

@PUT
@Path("/confirmReading")
void confirmReading(@QueryParam("readingId")
 long readingId,
 @QueryParam("version")
 String version)
             throws com.logicaldoc.core.security.authentication.AuthenticationException,
com.logicaldoc.webservice.WebserviceException,
com.logicaldoc.core.PersistenceException,
IOException

Confirms a reading request

Parameters:

readingId - identifier of the reading request

version - exact version of the document being confirmed(can be null)

Throws:

IOException - I/O error

com.logicaldoc.core.PersistenceException - Error in the database layer

com.logicaldoc.webservice.WebserviceException - Error in the webservice logic

com.logicaldoc.core.security.authentication.AuthenticationException - The user was not authenticated

getUnconfirmedReadings

@GET
@Path("/getUnconfirmedReadings")
List<WSReadingRequest> getUnconfirmedReadings()
                                       throws com.logicaldoc.core.security.authentication.AuthenticationException,
com.logicaldoc.webservice.WebserviceException,
com.logicaldoc.core.PersistenceException,
IOException

Gets the list of all the unconfirmed readings requested to the current user

Throws:

IOException - I/O error

com.logicaldoc.core.PersistenceException - Error in the database layer

com.logicaldoc.webservice.WebserviceException - Error in the webservice logic

com.logicaldoc.core.security.authentication.AuthenticationException - The user was not authenticated