Package net.webpdf.wsclient.schema.operation

Class TranscribeType

  • All Implemented Interfaces:
    ParameterInterface
    public class TranscribeType
extends BaseToolboxType
     <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">The transcribe operation element can be used to convert a PDF document into other document formats. Errors and inaccuracies can always occur during such conversions, so the endpoint allows a report to be generated to detect and evaluate possible transfer errors both in the event of an error and in the event of a success.</p>

    Java class for TranscribeType complex type

    .

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

    
 <complexType name="TranscribeType">
   <complexContent>
     <extension base="{http://schema.webpdf.de/1.0/operation}BaseToolboxType">
       <choice>
         <element name="html" type="{http://schema.webpdf.de/1.0/operation}HtmlTranscribeType"/>
       </choice>
       <attribute name="errorReport" type="{http://schema.webpdf.de/1.0/operation}TranscribeErrorReportType" default="none" />
       <attribute name="successReport" type="{http://schema.webpdf.de/1.0/operation}TranscribeSuccessReportType" default="none" />
       <attribute name="failureLevel" type="{http://schema.webpdf.de/1.0/operation}FailureType" default="error" />
     </extension>
   </complexContent>
 </complexType>

    • Field Detail

      • errorReport

        protected TranscribeErrorReportType errorReport
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">This parameter determines if and in which form the XML report for a failed conversion is returned.
                                 <ul><li>none = XML report is not returned</li><li>message = XML report will be delivered as part of the error message</li><li>file = XML report is saved to file</li></ul></p>

      • successReport

        protected TranscribeSuccessReportType successReport
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">This parameter determines if and in which form the XML report for a successful conversion is returned.
                                 <ul><li>none = XML report is not returned</li><li>linked = XML report is appended to the end of the target document.</li><li>zip = target document and XML report are packed together in a ZIP archive.</li></ul></p>
 
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema"><b>Important:</b>
                                 The format of the document created at "errorReport" and "successReport" is described via the http://schema.webpdf.de/1.0/report/transcribe.xsd schema.
                             </p>

      • failureLevel

        protected FailureType failureLevel
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">This parameter determines at which error level the conversion should fail, you can use this parameter to automatically reject also results with lower precision as failure
                                 <ul><li>warning = Documents for which warnings occur will also cause the conversion to fail.</li><li>missingContent = Documents for which not all content could be converted correctly will also be considered as failures.</li><li>error = Only if a conversion of the document did not lead to any meaningful result document, this is evaluated as failure, even if contents should be missing.</li></ul></p>

    • Constructor Detail

      • TranscribeType

        public TranscribeType()

    • Method Detail

      • isSetHtml

        public boolean isSetHtml()

      • getErrorReport

        public TranscribeErrorReportType getErrorReport()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">This parameter determines if and in which form the XML report for a failed conversion is returned.
                                 <ul><li>none = XML report is not returned</li><li>message = XML report will be delivered as part of the error message</li><li>file = XML report is saved to file</li></ul></p>
        Returns:
        possible object is TranscribeErrorReportType

      • isSetErrorReport

        public boolean isSetErrorReport()

      • getSuccessReport

        public TranscribeSuccessReportType getSuccessReport()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">This parameter determines if and in which form the XML report for a successful conversion is returned.
                                 <ul><li>none = XML report is not returned</li><li>linked = XML report is appended to the end of the target document.</li><li>zip = target document and XML report are packed together in a ZIP archive.</li></ul></p>
 
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema"><b>Important:</b>
                                 The format of the document created at "errorReport" and "successReport" is described via the http://schema.webpdf.de/1.0/report/transcribe.xsd schema.
                             </p>
        Returns:
        possible object is TranscribeSuccessReportType

      • isSetSuccessReport

        public boolean isSetSuccessReport()

      • getFailureLevel

        public FailureType getFailureLevel()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">This parameter determines at which error level the conversion should fail, you can use this parameter to automatically reject also results with lower precision as failure
                                 <ul><li>warning = Documents for which warnings occur will also cause the conversion to fail.</li><li>missingContent = Documents for which not all content could be converted correctly will also be considered as failures.</li><li>error = Only if a conversion of the document did not lead to any meaningful result document, this is evaluated as failure, even if contents should be missing.</li></ul></p>
        Returns:
        possible object is FailureType

      • isSetFailureLevel

        public boolean isSetFailureLevel()