Package de.aeb.xnsg.documentcore.bf

Class ProcessPDFOptionsDTO

java.lang.Object
de.aeb.xnsg.documentcore.bf.ProcessPDFOptionsDTO
public class ProcessPDFOptionsDTO extends Object
Processing options for the pdf document.

  • Field Details

    • RESULTTYPE_PDFCLASSIC

      public static final String RESULTTYPE_PDFCLASSIC
      See Also:

    • RESULTTYPE_PDFXFAPREVIEW

      public static final String RESULTTYPE_PDFXFAPREVIEW
      See Also:

    • RESULTTYPE_PDFXFAEDIT

      public static final String RESULTTYPE_PDFXFAEDIT
      See Also:

    • isPrintDocument

      public Boolean isPrintDocument
      If true, the document will be converted to PDF classic and printed. The field ProcessPDFRequestDTO.printSettings must be filled if this option is set to true.

    • isReturnPDF

      public Boolean isReturnPDF
      Should the business facade return the generated PDF-XFA or PDF-Classic document.

    • resultType

      public String resultType
      The result type of the PDF document, possible options are:
      • PDFCLASSIC
      • PDFXFAPREVIEW
      • PDFXFAEDIT

    • isTrace

      public Boolean isTrace
      Should the conversion activities be traced (e.g. Groovy/Rhino script results)

    • timeout

      public Long timeout
      The timeout (in milliseconds) specifies how long it shall be waited for an answer. The null value means practically infinite timeout (legacy behavior, though in fact there is now a 30 minutes timeout).

      If the conversion task does not succeed to complete within the timeout, the task will be cancelled and an exception will be thrown.

    • timeoutSubmit

      public Long timeoutSubmit
      The timeout (in milliseconds) specifies how long it shall be waited for the task to be accepted for execution. The null value means some reasonable default value.

      If the conversion task does not succeed to start its execution within the timeout, the task will be cancelled and an exception will be thrown.

      The timeoutSubmit should be substantially smaller then timeout

    • traceLanguageISOCode

      public String traceLanguageISOCode
      The language ISO code of the language which should be used to produce the trace length of the ISO Code: 2

    • globalPageOffset

      public PDFPageOffsetDTO globalPageOffset
      Global page offset adjustments when converting XFA -> classic PDF.

    • pageOffsets

      public PDFPageOffsetDTO[] pageOffsets
      Page specific page offset adjustments when converting XFA -> classic PDF.

    • isPrintedOnBlankPaper

      public Boolean isPrintedOnBlankPaper
      This option is implemented in order to support printing form background on a blank paper, i.e. not only the data on a pre-printed paper form.

      If set to true, all document elements, which are normally only visible in preview mode, but not printed on paper, will also be printed. For compatibility, it applies also to all XFAArea's with the name "Layout" (=PDFXFAHelper.LAYOUT_GROUP_NAME).

      If set to false, the preview-only elements will either be included in a PDF layer, which is visible in the Acrobat Reader but not printed on the printer (PDF 1.5) or completely excluded from the document (PDF 1.4).

      See Also:

    • isConvertToPDF14

      public Boolean isConvertToPDF14
      If set to true, PDF 1.4 is created (instead of PDF 1.5). Depending on isPrintedOnBlankPaper, the preview-only elements are then either included or excluded from the document.
      See Also:

    • previewURL

      public String previewURL
      The URL which should be used to send the preview data to if a preview PDF-XFA document is generated.

    • notUnicodeFontEncoding

      public String notUnicodeFontEncoding
      If null, the font encoding "Identity-H" will be taken for embedded True-Type fonts, else the specified encoding (e.g. "Cp1252") applies. However, this may lead to some Unicode characters unable to be displayed.

    • isReturnPageMapping

      public Boolean isReturnPageMapping
      If set to true the caller gets also page mapping which maps page names to page numbers.

  • Constructor Details

    • ProcessPDFOptionsDTO

      public ProcessPDFOptionsDTO()