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

Interface ImportFolderService

All Superinterfaces:
com.google.gwt.user.client.rpc.RemoteService
@RemoteServiceRelativePath("importfolder") public interface ImportFolderService extends com.google.gwt.user.client.rpc.RemoteService
The client side stub for the ImportFolder Service. This service gives all needed methods to handle import folders.

  • Nested Class Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    changeStatus(long id, boolean enabled)
    Changes a importFolder enabled/disabled status
    void
    delete(long id)
    Deletes a given import folder
    GUIImportFolder
    getImportFolder(long id)
    Loads a given import folder from the database
    void
    resetCache(long id)
    Cleans the cache
    void
    resetCounter(long id)
    Reset the import counter
    GUIImportFolder
    save(GUIImportFolder importFolder)
    Creates or updates an import folder
    boolean
    test(long id)
    Tests the connection to the given import folder

  • Method Details

    • delete

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

    • save

      GUIImportFolder save(GUIImportFolder importFolder) throws ServerException
      Creates or updates an import folder
      Parameters:
      importFolder - the import folder to save
      Returns:
      the saved import folder
      Throws:
      ServerException - an error happened in the server application

    • getImportFolder

      GUIImportFolder getImportFolder(long id) throws ServerException
      Loads a given import folder from the database
      Parameters:
      id - identifier of the import folder
      Returns:
      the import folder retrieved by the server application
      Throws:
      ServerException - an error happened in the server application

    • test

      boolean test(long id) throws ServerException
      Tests the connection to the given import folder
      Parameters:
      id - identifier of the import folder
      Returns:
      if the import folder has been connected and able to work
      Throws:
      ServerException - an error happened in the server application

    • changeStatus

      void changeStatus(long id, boolean enabled) throws ServerException
      Changes a importFolder enabled/disabled status
      Parameters:
      id - identifier of the import folder
      enabled - flag to enable / disable the import folder
      Throws:
      ServerException - an error happened in the server application

    • resetCounter

      void resetCounter(long id) throws ServerException
      Reset the import counter
      Parameters:
      id - identifier of the import folder
      Throws:
      ServerException - an error happened in the server application

    • resetCache

      void resetCache(long id) throws ServerException
      Cleans the cache
      Parameters:
      id - identifier of the import folder
      Throws:
      ServerException - an error happened in the server application