Package com.logicaldoc.gui.frontend.client.services

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

    Nested Classes
    Modifier and Type
    Interface
    Description
    static class 
    ReadingRequestService.Instance
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    askReadingConfirmation(Long[] docIds, long[] recipientIds, boolean alertConfirmation, String comment)
    Asks some users to confirm the reading of a set of documents
    void
    confirmReadings(long[] readingIds, String version)
    Confirms the read completion of a given file version
    void
    delete(long readingId)
    Deletes a reading request.
    GUIReadingRequest[]
    getUnconfimedReadings()
    Retrieves all the unconfirmed readings by the current user
    void
    notityReadingRequest(long readingId)
    Notifies again a reading request.

  • Method Details

    • askReadingConfirmation

      void askReadingConfirmation(Long[] docIds, long[] recipientIds, boolean alertConfirmation, String comment) throws ServerException
      Asks some users to confirm the reading of a set of documents
      Parameters:
      docIds - identifiers of the documents
      recipientIds - identifiers of the recipients
      comment - an optional message to include in the notification
      alertConfirmation - if the requestor must be notified on reading confirmation
      Throws:
      ServerException - an error happened in the server application

    • confirmReadings

      void confirmReadings(long[] readingIds, String version) throws ServerException
      Confirms the read completion of a given file version
      Parameters:
      readingIds - identifiers of the readings to confirm, all must refer to the same document
      version - the version
      Throws:
      ServerException - an error happened in the server application

    • delete

      void delete(long readingId) throws ServerException
      Deletes a reading request.
      Parameters:
      readingId - identifier of the reading request to delete
      Throws:
      ServerException - an error happened in the server application

    • notityReadingRequest

      void notityReadingRequest(long readingId) throws ServerException
      Notifies again a reading request.
      Parameters:
      readingId - identifier of the reading request to notify
      Throws:
      ServerException - an error happened in the server application

    • getUnconfimedReadings

      GUIReadingRequest[] getUnconfimedReadings() throws ServerException
      Retrieves all the unconfirmed readings by the current user
      Throws:
      ServerException - an error happened in the server application