Interface ReadingRequestService
- All Superinterfaces:
com.google.gwt.user.client.rpc.RemoteService
@RemoteServiceRelativePath("readingrequest")
public interface ReadingRequestService
extends com.google.gwt.user.client.rpc.RemoteService
The client side stub for the Reading Service. This service allows the reading
requests / confirmations.
- Since:
- 8.8.6
- Author:
- Marco Meschieri - LogicalDOC
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
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 documentsvoid
confirmReadings
(List<Long> readingIds, String version) Confirms the read completion of a given file versionvoid
delete
(long readingId) Deletes a reading request.Retrieves all the unconfirmed readings by the current uservoid
notityReadingRequest
(long readingId) Notifies again a reading request.
-
Method Details
-
askReadingConfirmation
void askReadingConfirmation(List<Long> docIds, List<Long> userIds, List<Long> groupIds, boolean alertConfirmation, String comment) throws ServerException Asks some users to confirm the reading of a set of documents- Parameters:
docIds
- identifiers of the documentsuserIds
- identifiers of the recipientsgroupIds
- identifiers of the groupscomment
- an optional message to include in the notificationalertConfirmation
- if the requestor must be notified on reading confirmation- Throws:
ServerException
- an error happened in the server application
-
confirmReadings
Confirms the read completion of a given file version- Parameters:
readingIds
- identifiers of the readings to confirm, all must refer to the same documentversion
- the version- Throws:
ServerException
- an error happened in the server application
-
delete
Deletes a reading request.- Parameters:
readingId
- identifier of the reading request to delete- Throws:
ServerException
- an error happened in the server application
-
notityReadingRequest
Notifies again a reading request.- Parameters:
readingId
- identifier of the reading request to notify- Throws:
ServerException
- an error happened in the server application
-
getUnconfimedReadings
Retrieves all the unconfirmed readings by the current user- Returns:
- those readings not already confirmed
- Throws:
ServerException
- an error happened in the server application
-