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

Interface ZohoService

All Superinterfaces:
com.google.gwt.user.client.rpc.RemoteService
@RemoteServiceRelativePath("zoho") public interface ZohoService extends com.google.gwt.user.client.rpc.RemoteService
The client side stub for the Zoho Service.
Since:
7.5.2
Author:
Marco Meschieri - LogicalDOC

  • Nested Class Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    GUIDocument
    checkin(long docId, String comment, boolean major)
    Performs the check-in of a Zoho's document into the LogicalDOC repository
    void
    delete(String resourceId)
    Deletes a document in Zoho
    boolean
    exportDocuments(String targetFolderId, long[] folderIds, Long[] docIds)
    Exports documents and folders into Zoho
    int
    importDocuments(long targetFolder, String[] folderCompositeIds, String[] documentIds)
    Exports documents and folders from Zoho into LogicalDOC
    String[]
    loadSettings()
    Save the settings used by the Zoho module
    String
    saveSettings(String clientId, String clientSecret)
    Save the settings used by the Zoho module
    String
    upload(long docId)
    Uploads a document to Zoho.

  • Method Details

    • saveSettings

      String saveSettings(String clientId, String clientSecret) throws ServerException
      Save the settings used by the Zoho module
      Parameters:
      clientId - identifier of the client
      clientSecret - the secret key specified by he user
      Returns:
      The URL of the consent page
      Throws:
      ServerException - an error happened in the server application

    • loadSettings

      String[] loadSettings() throws ServerException
      Save the settings used by the Zoho module
      Returns:
      clientId, clientSecret
      Throws:
      ServerException - an error happened in the server application

    • exportDocuments

      boolean exportDocuments(String targetFolderId, long[] folderIds, Long[] docIds) throws ServerException
      Exports documents and folders into Zoho
      Parameters:
      targetFolderId - the target path in Zoho (must be a folder)
      folderIds - Ids of the folders to be imported (all subfolders and docs will be imported as well
      docIds - Ids of the documents to be imported
      Returns:
      true if the import was successful
      Throws:
      ServerException - error in the server application

    • importDocuments

      int importDocuments(long targetFolder, String[] folderCompositeIds, String[] documentIds) throws ServerException
      Exports documents and folders from Zoho into LogicalDOC
      Parameters:
      targetFolder - ID of the root folder that will receive the imported elements
      folderCompositeIds - array of the identifiers of the Zoho folder each one is a tokenized string folder_name:folder_id
      documentIds - identifiers of the documents in Zoho to be imported
      Returns:
      number of imported files
      Throws:
      ServerException - error in the server application

    • upload

      String upload(long docId) throws ServerException
      Uploads a document to Zoho.
      Parameters:
      docId - ID of the document to upload
      Returns:
      The resourceId of the uploaded document
      Throws:
      ServerException - error in the server application

    • delete

      void delete(String resourceId) throws ServerException
      Deletes a document in Zoho
      Parameters:
      resourceId - identifier of the document to delete
      Throws:
      ServerException - error in the server application

    • checkin

      GUIDocument checkin(long docId, String comment, boolean major) throws ServerException
      Performs the check-in of a Zoho's document into the LogicalDOC repository
      Parameters:
      docId - identifier of the document to update
      comment - The comment left for the checkin
      major - If this is a major or minor release
      Returns:
      The checked-in document
      Throws:
      ServerException - error in the server application