Class RestReadingRequestService
java.lang.Object
com.logicaldoc.webservice.AbstractService
com.logicaldoc.enterprise.webservice.soap.endpoint.SoapReadingRequestService
com.logicaldoc.enterprise.webservice.rest.endpoint.RestReadingRequestService
- All Implemented Interfaces:
ReadingRequestService
,ReadingRequestService
@Path("/")
public class RestReadingRequestService
extends SoapReadingRequestService
implements ReadingRequestService
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
askReadingConfirmation
(Long[] docIds, Long[] userIds, Long[] groupIds, boolean alertConfirmation, String comment) Asks some users to confirm the reading of a set of documentsvoid
confirmReading
(long readingId, String version) Confirms a reading requestGets the list of all the unconfirmed readings requested to the current userMethods inherited from class com.logicaldoc.enterprise.webservice.soap.endpoint.SoapReadingRequestService
askReadingConfirmation, confirmReading, getUnconfirmedReadings
Methods inherited from class com.logicaldoc.webservice.AbstractService
convertDateToString, convertStringToDate, getCurrentMessage, isValidateSession, setCurrentMessage, setValidateSession
-
Constructor Details
-
RestReadingRequestService
public RestReadingRequestService()
-
-
Method Details
-
askReadingConfirmation
@GET @Path("/askReadingConfirmation") public void askReadingConfirmation(@QueryParam("docIds") Long[] docIds, @QueryParam("userIds") Long[] userIds, @QueryParam("groupIds") Long[] groupIds, @QueryParam("groupIdsboolean") boolean alertConfirmation, @QueryParam("comment") 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 interfaceReadingRequestService
- Parameters:
docIds
- identifiers of the documentsuserIds
- identifiers of the recipient usersgroupIds
- identifiers of the recipient groupsalertConfirmation
- if the requestor must be notified on reading confirmationcomment
- an optional message to include in the notification- Throws:
com.logicaldoc.core.security.authentication.AuthenticationException
- The user was not authenticatedcom.logicaldoc.webservice.WebserviceException
- Error in the webservice logiccom.logicaldoc.core.PersistenceException
- Error in the database layerIOException
- I/O error
-
confirmReading
@GET @Path("/confirmReading") public 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 Description copied from interface:ReadingRequestService
Confirms a reading request- Specified by:
confirmReading
in interfaceReadingRequestService
- Parameters:
readingId
- identifier of the reading requestversion
- exact version of the document being confirmed(can be null)- Throws:
com.logicaldoc.core.security.authentication.AuthenticationException
- The user was not authenticatedcom.logicaldoc.webservice.WebserviceException
- Error in the webservice logiccom.logicaldoc.core.PersistenceException
- Error in the database layerIOException
- I/O error
-
getUnconfirmedReadings
@GET @Path("/getUnconfirmedReadings") public WSReadingRequest[] getUnconfirmedReadings() throws com.logicaldoc.core.security.authentication.AuthenticationException, com.logicaldoc.webservice.WebserviceException, com.logicaldoc.core.PersistenceException, IOExceptionDescription copied from interface:ReadingRequestService
Gets the list of all the unconfirmed readings requested to the current user- Specified by:
getUnconfirmedReadings
in interfaceReadingRequestService
- Throws:
com.logicaldoc.core.security.authentication.AuthenticationException
- The user was not authenticatedcom.logicaldoc.webservice.WebserviceException
- Error in the webservice logiccom.logicaldoc.core.PersistenceException
- Error in the database layerIOException
- I/O error
-