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

Interface StampService

  • All Superinterfaces:
    com.google.gwt.user.client.rpc.RemoteService
    @RemoteServiceRelativePath("stamp")
public interface StampService
extends com.google.gwt.user.client.rpc.RemoteService
    The client side stub for the Stamp Service. This service gives all needed methods to handle the stamps.

    • Nested Class Summary

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

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void addUsers​(long[] userIds, long stampId)
      Assigns users to stamp
      void applyStamp​(long[] docIds, GUIStamp stamp)
      Applies a stamp to the given document
      void changeStatus​(long stampId, boolean enabled)
      Changes a stamp enabled/disabled status
      void delete​(long id)
      Deletes a given stamp
      GUIStamp getStamp​(long stampId)
      Loads a given stamp from the database
      void removeUsers​(long[] userIds, long stampId)
      Remove users from stamp
      GUIStamp save​(GUIStamp stamp)
      Creates or updates a stamp
      void saveImage​(long stampId)
      Saves the stamp's image already uploaded

    • Method Detail

      • delete

        void delete​(long id)
     throws ServerException
        Deletes a given stamp
        Parameters:
        id - identifier of the stamp to delete
        Throws:
        ServerException - an error happened in the server application

      • saveImage

        void saveImage​(long stampId)
        throws ServerException
        Saves the stamp's image already uploaded
        Parameters:
        stampId - identifier of the stamp
        Throws:
        ServerException - an error happened in the server application

      • getStamp

        GUIStamp getStamp​(long stampId)
           throws ServerException
        Loads a given stamp from the database
        Parameters:
        stampId - identifier of the stamp
        Returns:
        the stamp retrieved by the server application
        Throws:
        ServerException - an error happened in the server application

      • changeStatus

        void changeStatus​(long stampId,
                  boolean enabled)
           throws ServerException
        Changes a stamp enabled/disabled status
        Parameters:
        stampId - identifier of the stamp
        enabled - the enabled status of the stamp
        Throws:
        ServerException - an error happened in the server application

      • applyStamp

        void applyStamp​(long[] docIds,
                GUIStamp stamp)
         throws ServerException
        Applies a stamp to the given document
        Parameters:
        docIds - identifiers of the documents
        stamp - the stamp to apply
        Throws:
        ServerException - an error happened in the server application

      • removeUsers

        void removeUsers​(long[] userIds,
                 long stampId)
          throws ServerException
        Remove users from stamp
        Parameters:
        userIds - identifiers of the users to remove from the stamp
        stampId - identifier of the stamp
        Throws:
        ServerException - an error happened in the server application

      • addUsers

        void addUsers​(long[] userIds,
              long stampId)
       throws ServerException
        Assigns users to stamp
        Parameters:
        userIds - identifiers of the users to associate to the stamp
        stampId - identifier of the stamp
        Throws:
        ServerException - an error happened in the server application