Package com.logicaldoc.enterprise.webservice.soap

Interface ReadingRequestService

All Known Implementing Classes:

RestReadingRequestService, SoapReadingRequestClient, SoapReadingRequestService

public interface ReadingRequestService

Web Service for handling reading requests

Since:

8.9.1

Author:

Marco Meschieri - LogicalDOC

Method Summary

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

Method Details

askReadingConfirmation

void askReadingConfirmation(String sid,
 Long[] docIds,
 Long[] userIds,
 Long[] groupIds,
 boolean alertConfirmation,
 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:

sid - Session identifier

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

void confirmReading(String sid,
 long readingId,
 String version)
             throws com.logicaldoc.core.security.authentication.AuthenticationException,
com.logicaldoc.webservice.WebserviceException,
com.logicaldoc.core.PersistenceException,
IOException

Confirms a reading request

Parameters:

sid - Session identifier

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

WSReadingRequest[] getUnconfirmedReadings(String sid)
                                   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

Parameters:

sid - Session identifier

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