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

Interface ShareFileService

All Superinterfaces:
com.google.gwt.user.client.rpc.RemoteService
@RemoteServiceRelativePath("sharefile") public interface ShareFileService extends com.google.gwt.user.client.rpc.RemoteService
The client side stub for the ShareFile Service.
Since:
7.2.1
Author:
Marco Meschieri - LogicalDOC

  • Nested Class Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    authorize(String clientId, String clientSecret)
    Saves the settings into the database and returns the authorization URL the user must be redirected to.
    boolean
    exportDocuments(String targetFolder, List<Long> folderIds, List<Long> docIds)
    Exports documents and folders into ShareFille
    int
    importDocuments(long targetFolder, List<String> itemIds)
     
    boolean
    isAuthorized()
    Checks if the current user is authorized to interact with ShreFile
    List<String>
    loadSettings()
    Retrieve the settings saved for connecting to FileShare

  • Method Details

    • exportDocuments

      boolean exportDocuments(String targetFolder, List<Long> folderIds, List<Long> docIds) throws ServerException
      Exports documents and folders into ShareFille
      Parameters:
      targetFolder - the target folder in ShareFile
      folderIds - Ids of the folders to be imported (all sub-folders and docs will be imported as well)
      docIds - Ids of the documents to be imported
      Returns:
      if the document have been exported successfully
      Throws:
      ServerException - an error happened in the server application

    • importDocuments

      int importDocuments(long targetFolder, List<String> itemIds) throws ServerException
      Throws:
      ServerException

    • loadSettings

      List<String> loadSettings() throws ServerException
      Retrieve the settings saved for connecting to FileShare
      Returns:
      the settings
      Throws:
      ServerException - an error happened in the server application

    • authorize

      String authorize(String clientId, String clientSecret) throws ServerException
      Saves the settings into the database and returns the authorization URL the user must be redirected to.
      Parameters:
      clientId - the client identifier
      clientSecret - the client secret
      Returns:
      the authorization URL
      Throws:
      ServerException - an error happened in the server application

    • isAuthorized

      boolean isAuthorized() throws ServerException
      Checks if the current user is authorized to interact with ShreFile
      Returns:
      if you are authorized
      Throws:
      ServerException - an error happened in the server application