Package com.technia.dsx.threedspace.doc.fcs

Interface FCSService

public interface FCSService
Service for managing FCS (File Content Service) tickets.

Provides operations to obtain checkout tickets for downloading files and checkin tickets for uploading files. Tickets are required for all file transfer operations.

Since:
2022-06-13

  • Method Details

    • getTicket

      @Remote(READ) DownloadTicketResult getTicket(com.technia.dsx.common.TenantSession session, String documentId, boolean zipFiles, String zipName, boolean checkout)
      Get the download ticket to download all the files associated to a document

      If the checkout parameter is true, lock and get the checkout ticket for a document; a zip is returned when multiple files exist.

      Parameters:
      session - The current session
      documentId - The ID of the document
      zipFiles - TRUE to zip the files on checkout
      zipName - The name of the ZIP file
      checkout - TRUE for a checkout, FALSE for a simple download.
      Returns:

    • getTicket

      @Remote(READ) DownloadTicketResult getTicket(com.technia.dsx.common.TenantSession session, String documentId, String fileId, String versionId)
      Parameters:
      session -
      documentId -
      fileId -
      versionId -
      Returns:

    • getTicket

      @Remote(READ) DownloadTicketResult getTicket(com.technia.dsx.common.TenantSession session, String documentId, String fileId, boolean checkout)
      Get the download ticket to download a specific file associated to a document.

      If the checkout argument is true then lock and get the checkout ticket.

      Parameters:
      session - The tenant session
      documentId - The document ID (REQUIRED)
      fileId - The file id (REQUIRED(
      checkout - True for checkout, false for download
      Returns:

    • getTicket

      DownloadTicketResult getTicket(com.technia.dsx.common.TenantSession session, boolean zipFiles, String zipFileName, boolean checkout)
      TODO: DOCUMENT ME
      Parameters:
      session -
      zipFiles -
      zipFileName -
      checkout -
      Returns:

    • getCheckinTicket

      @Remote(READ) CheckinTicketResult getCheckinTicket(com.technia.dsx.common.TenantSession session, String documentId, String store, String policy)
      Get an checkin ticket to upload files to FCS in order to add or modify a file for a given document.
      Parameters:
      session - The tenant session
      documentId - The document ID (REQUIRED)
      store - Optional store override
      policy - Optional policy override
      Returns:
      The checkin ticket result

    • getCheckinTicket

      CheckinTicketResult getCheckinTicket(com.technia.dsx.common.TenantSession session, String store, String policy, Integer fileCount, Integer ticketCount)
      Get a checkin ticket to upload files to FCS to a document that does not yet exist.
      Parameters:
      session - The tenant session
      store - Optional store override
      policy - Optional policy override
      fileCount - Optional argument specifying the nr of files to be checked in
      ticketCount - Optional argument specifying how many tickets to generate
      Returns:
      The checkin ticket result