Package net.webpdf.wsclient.schema.operation

Class PdfaType.Convert

  • Enclosing class:
    PdfaType
    public static class PdfaType.Convert
extends Object

    Java class for anonymous complex type

    .

    The following schema fragment specifies the expected content contained within this class.

    
 <complexType>
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <all>
         <element name="zugferd" type="{http://schema.webpdf.de/1.0/operation}ZugferdType" minOccurs="0"/>
         <element name="errorCorrection" type="{http://schema.webpdf.de/1.0/operation}PdfaErrorCorrectionType" minOccurs="0"/>
       </all>
       <attribute name="level" type="{http://schema.webpdf.de/1.0/operation}PdfaLevelType" default="3b" />
       <attribute name="imageQuality" default="75">
         <simpleType>
           <restriction base="{http://www.w3.org/2001/XMLSchema}int">
             <minInclusive value="0"/>
             <maxInclusive value="100"/>
           </restriction>
         </simpleType>
       </attribute>
       <attribute name="errorReport" type="{http://schema.webpdf.de/1.0/operation}PdfaErrorReportType" default="none" />
       <attribute name="successReport" type="{http://schema.webpdf.de/1.0/operation}PdfaSuccessReportType" default="none" />
       <attribute name="autoTagging" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
     </restriction>
   </complexContent>
 </complexType>

    • Field Detail

      • level

        protected PdfaLevelType level
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p106995_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p874552_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Specifies the compliance level when creating or validating PDF/A documents (as specified in ISO 19005).</p>

      • imageQuality

        protected Integer imageQuality
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p106995_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p874552_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">The quality for images which must be transformed during the conversion because they use a compression which is not allowed (e.g. JPX is not allowed in PDF/A-1) is defined using this parameter. Values in a range from 1 to 100 are allowed whereby a higher value means better quality, but also larger PDF documents.</p>

      • errorReport

        protected PdfaErrorReportType errorReport
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p106995_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p874552_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">This parameter is used to define whether and in which format the XML report for a failed conversion will be returned.
                                     <ul><li>none = An XML report will not be returned</li><li>message = The XML report will be returned as part of the error message</li><li>file = The XML report will be saved in a file</li></ul></p>

      • successReport

        protected PdfaSuccessReportType successReport
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p106995_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p874552_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">This parameter is used to define whether and in which format the XML report for a successful conversion will be returned.
                                     <ul><li>none = An XML report will not be returned</li><li>linked = The XML report will be appended at the end of the PDF/A document.</li><li>zip = The PDF/A document and the XML report will be packaged together in a ZIP archive.</li></ul></p>
 
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p106995_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p874552_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema"><b>Tip:</b>
                                     The format of the document generated with "errorReport" and "successReport" is described by the http://schema.webpdf.de/1.0/report/pdfa.xsd schema.
                                 </p>

      • autoTagging

        protected Boolean autoTagging
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p106995_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p874552_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">In order to convert a document to conformity levels PDF/A 1a-3a, the entire document must have appropriate structure information (tags). If auto tagging is enabled, the corresponding structure information (in the form of page tags) will be generated automatically before the actual conversion.</p>

    • Constructor Detail

      • Convert

        public Convert()

    • Method Detail

      • getZugferd

        public ZugferdType getZugferd()
        Gets the value of the zugferd property.
        Returns:
        possible object is ZugferdType

      • setZugferd

        public void setZugferd​(ZugferdType value)
        Sets the value of the zugferd property.
        Parameters:
        value - allowed object is ZugferdType

      • isSetZugferd

        public boolean isSetZugferd()

      • isSetErrorCorrection

        public boolean isSetErrorCorrection()

      • getLevel

        public PdfaLevelType getLevel()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p106995_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p874552_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Specifies the compliance level when creating or validating PDF/A documents (as specified in ISO 19005).</p>
        Returns:
        possible object is PdfaLevelType

      • isSetLevel

        public boolean isSetLevel()

      • getImageQuality

        public int getImageQuality()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p106995_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p874552_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">The quality for images which must be transformed during the conversion because they use a compression which is not allowed (e.g. JPX is not allowed in PDF/A-1) is defined using this parameter. Values in a range from 1 to 100 are allowed whereby a higher value means better quality, but also larger PDF documents.</p>
        Returns:
        possible object is Integer

      • setImageQuality

        public void setImageQuality​(int value)
        Sets the value of the imageQuality property.
        Parameters:
        value - allowed object is Integer
        See Also:
        getImageQuality()

      • isSetImageQuality

        public boolean isSetImageQuality()

      • unsetImageQuality

        public void unsetImageQuality()

      • getErrorReport

        public PdfaErrorReportType getErrorReport()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p106995_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p874552_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">This parameter is used to define whether and in which format the XML report for a failed conversion will be returned.
                                     <ul><li>none = An XML report will not be returned</li><li>message = The XML report will be returned as part of the error message</li><li>file = The XML report will be saved in a file</li></ul></p>
        Returns:
        possible object is PdfaErrorReportType

      • isSetErrorReport

        public boolean isSetErrorReport()

      • getSuccessReport

        public PdfaSuccessReportType getSuccessReport()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p106995_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p874552_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">This parameter is used to define whether and in which format the XML report for a successful conversion will be returned.
                                     <ul><li>none = An XML report will not be returned</li><li>linked = The XML report will be appended at the end of the PDF/A document.</li><li>zip = The PDF/A document and the XML report will be packaged together in a ZIP archive.</li></ul></p>
 
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p106995_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p874552_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema"><b>Tip:</b>
                                     The format of the document generated with "errorReport" and "successReport" is described by the http://schema.webpdf.de/1.0/report/pdfa.xsd schema.
                                 </p>
        Returns:
        possible object is PdfaSuccessReportType

      • isSetSuccessReport

        public boolean isSetSuccessReport()

      • isAutoTagging

        public boolean isAutoTagging()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p106995_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p874552_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">In order to convert a document to conformity levels PDF/A 1a-3a, the entire document must have appropriate structure information (tags). If auto tagging is enabled, the corresponding structure information (in the form of page tags) will be generated automatically before the actual conversion.</p>
        Returns:
        possible object is Boolean

      • setAutoTagging

        public void setAutoTagging​(boolean value)
        Sets the value of the autoTagging property.
        Parameters:
        value - allowed object is Boolean
        See Also:
        isAutoTagging()

      • isSetAutoTagging

        public boolean isSetAutoTagging()

      • unsetAutoTagging

        public void unsetAutoTagging()