Package net.webpdf.wsclient.openapi

Class OperationConverter

  • public class OperationConverter
extends Object
    Performs the conversion of a document.

    • Constructor Detail

      • OperationConverter

        public OperationConverter()

    • Method Detail

      • getAccessPassword

        @Nullable
public @Nullable String getAccessPassword()
        This parameter can be used to declare a password that will be used to open the source document if it is protected. **Important:** This option is currently only supported for Microsoft Office 97-2003 binary documents and Microsoft Office 2007 documents. Only the default password methods are supported. Encryption based on digital certificates is not supported.
        Returns:
        accessPassword

      • setAccessPassword

        public void setAccessPassword​(String accessPassword)

      • getCompression

        @Nullable
public @Nullable Boolean getCompression()
        If \"true,\" the data objects in the PDF document will be compressed (ZLib compression), reducing the size of the document.
        Returns:
        compression

      • setCompression

        public void setCompression​(Boolean compression)

      • getDpi

        @Nullable
public @Nullable Integer getDpi()
        Used to set the DPI solution (pixels per inch) for images. minimum: 0 maximum: 9600
        Returns:
        dpi

      • setDpi

        public void setDpi​(Integer dpi)

      • getEmbedFonts

        @Nullable
public @Nullable Boolean getEmbedFonts()
        If \"true,\" fonts will be embedded in the PDF document that is created. **Important:**: If the original fonts are not available on the conversion system, substitute fonts may be embedded instead. **Important:**: If, after the conversion, you want to convert the PDF document to PDF/A, you should not embed any of the fonts, but should instead let the \"Pdfa\" web service do this.
        Returns:
        embedFonts

      • setEmbedFonts

        public void setEmbedFonts​(Boolean embedFonts)

      • getFileExtension

        @Nullable
public @Nullable String getFileExtension()
        If you use this attribute to enter an extension for the file (e.g., \"doc\") that is currently being processed, automatic file format detection will be disabled. Normally, webPDF does not detect file formats based on the corresponding file extension, but on the file contents instead. Accordingly, webPDF will analyze the file and assign the file the appropriate \"mime-type\" so that the appropriate file converter can then be selected. **Important:**: You should only set a file extension in exceptional cases, as this will completely disable automatic detection. If, for instance, you specify an extension for which webPDF does not have a \"mime-type,\" the conversion will fail.
        Returns:
        fileExtension

      • setFileExtension

        public void setFileExtension​(String fileExtension)

      • getJpegQuality

        @Nullable
public @Nullable Integer getJpegQuality()
        Used to set the quality (as a percentage) of JPEG images in the PDF document. minimum: 0 maximum: 100
        Returns:
        jpegQuality

      • setJpegQuality

        public void setJpegQuality​(Integer jpegQuality)

      • getMaxRecursion

        @Nullable
public @Nullable Integer getMaxRecursion()
        Sets the maximum recursions, that may occur when converting a document's attachments. **Important:** This parameter is intended for internal use only. Please only use this, if you really are sure you need to do so. minimum: 1
        Returns:
        maxRecursion

      • setMaxRecursion

        public void setMaxRecursion​(Integer maxRecursion)

      • getOfficeBridge

        @Nullable
public @Nullable Object getOfficeBridge()
        Used to specify whether \"Office Bridge\" should be used when converting Word, Excel, and PowerPoint documents. If this element is set (and Office Bridge is enabled), the document will be converted using the Office software installed on the server.
        Returns:
        officeBridge

      • setOfficeBridge

        public void setOfficeBridge​(Object officeBridge)

      • getPages

        @Nullable
public @Nullable String getPages()
        A text that defines the page range for the export. Individual pages or a range of pages can be defined here. If the text is empty, the entire file will be exported (e.g.: \"1-10\" or \"1,2,5-10\")
        Returns:
        pages

      • setPages

        public void setPages​(String pages)

      • getPdfa

        @Nullable
public @Nullable OperationPdfa getPdfa()
        Get pdfa
        Returns:
        pdfa

      • getReduceResolution

        @Nullable
public @Nullable Boolean getReduceResolution()
        If \"true,\" then the DPI resolution of graphics is reduced. The reduction value is set with \"dpi.\"
        Returns:
        reduceResolution

      • setReduceResolution

        public void setReduceResolution​(Boolean reduceResolution)

      • getSharePointBridge

        @Nullable
public @Nullable Object getSharePointBridge()
        Used to specify whether \"SharePoint Bridge\" should be used when converting a Word document. If the element is set, the Word document will be converted using the SharePoint service (if SharePoint Bridge is enabled).
        Returns:
        sharePointBridge

      • setSharePointBridge

        public void setSharePointBridge​(Object sharePointBridge)

      • getSignature

        @Nullable
public @Nullable OperationSignature getSignature()
        Get signature
        Returns:
        signature

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object