Package com.logicaldoc.enterprise.webservice.soap.client

Class SoapReadingRequestClient

java.lang.Object

com.logicaldoc.webservice.soap.client.SoapClient<ReadingRequestService>

com.logicaldoc.enterprise.webservice.soap.client.SoapReadingRequestClient

All Implemented Interfaces:

ReadingRequestService

public class SoapReadingRequestClient
extends com.logicaldoc.webservice.soap.client.SoapClient<ReadingRequestService>
implements ReadingRequestService

Enterprise Document Web Service client.

Since:

8.1.2

Author:

Marco Meschieri - LogicalDOC

Constructor Summary

Constructors

Constructor	Description
SoapReadingRequestClient(String endpoint)
SoapReadingRequestClient(String endpoint, int timeout)

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

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SoapReadingRequestClient

public SoapReadingRequestClient(String endpoint)

SoapReadingRequestClient

public SoapReadingRequestClient(String endpoint,
 int timeout)

Method Details

askReadingConfirmation

public 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

Description copied from interface: ReadingRequestService

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

Specified by:

askReadingConfirmation in interface ReadingRequestService

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:

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

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

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

IOException - I/O error

confirmReading

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

Description copied from interface: ReadingRequestService

Confirms a reading request

Specified by:

confirmReading in interface ReadingRequestService

Parameters:

sid - Session identifier

readingId - identifier of the reading request

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

Throws:

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

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

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

IOException - I/O error

getUnconfirmedReadings

public WSReadingRequest[] getUnconfirmedReadings(String sid)
                                          throws com.logicaldoc.core.security.authentication.AuthenticationException,
com.logicaldoc.webservice.WebserviceException,
com.logicaldoc.core.PersistenceException,
IOException

Description copied from interface: ReadingRequestService

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

Specified by:

getUnconfirmedReadings in interface ReadingRequestService

Parameters:

sid - Session identifier

Throws:

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

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

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

IOException - I/O error