Package com.avoka.fc.core.service

Interface IRenderReceiptService

All Known Implementing Classes:
AbstractRenderReceiptService, AcroFormRenderReceiptService, BlankTestReceiptService, FluentRenderReceiptService, GroovyRenderReceiptService, LocalProcessRenderReceiptService, PhantomJSRenderReceiptService, PhantomJSRenderReceiptServiceV2, PuppeteerRenderReceiptService
public interface IRenderReceiptService
Provides an interface to render PDF receipt documents. This class is used internally by PDF receipt rendering services.
Since:
4.3.0

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    renderReceipt(Submission submission, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, RequestLog requestLog)
    Render the PDF Receipt given the submission.
    byte[]
    renderReceipt(Submission submission, String mode)
    Return a PDF Receipt byte array rendered from the submission.
    boolean
    requiresLiveCycle()
    Return true if the service requires Adobe LiveCycle.
    void
    setMaxProcesses(Integer value)
    Set the maximum number of concurrent processes.
    void
    setTestMode(boolean testMode)
    Specify whether running in test mode an render receipt changes should not be committed to database.

  • Method Details

    • renderReceipt

      void renderReceipt(Submission submission, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, RequestLog requestLog) throws ApplicationException
      Render the PDF Receipt given the submission.
      Parameters:
      submission - the submission (required)
      request - - the users Http servlet request (required)
      response - - the Http servlet response to render to
      requestLog - - the request log parameter
      Throws:
      ApplicationException - if an error occurs at runtime

    • renderReceipt

      byte[] renderReceipt(Submission submission, String mode) throws ApplicationException
      Return a PDF Receipt byte array rendered from the submission.
      Parameters:
      submission - the submission
      mode - the render receipt mode RequestLog.RECEIPT_MODES
      Returns:
      the receipt data in PDF
      Throws:
      ApplicationException - if an error occurs at runtime

    • requiresLiveCycle

      boolean requiresLiveCycle()
      Return true if the service requires Adobe LiveCycle.
      Returns:
      true if the service requires Adobe LiveCycle

    • setTestMode

      void setTestMode(boolean testMode)
      Specify whether running in test mode an render receipt changes should not be committed to database.
      Parameters:
      testMode - Specify whether running in test mode an render receipt changes should not be committed to database
      Since:
      4.1.15

    • setMaxProcesses

      void setMaxProcesses(Integer value)
      Set the maximum number of concurrent processes.
      Parameters:
      value - the maximum number of concurrent processes
      Since:
      5.0.3