java.lang.Object
- net.webpdf.wsclient.openapi.OperationConvertPdfa

public class OperationConvertPdfa
extends Object

Used to convert a PDF document to PDF/A.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`OperationConvertPdfa.ErrorReportEnum`	This parameter is used to define whether and in which format the XML report for a failed conversion will be returned
`static class`	`OperationConvertPdfa.LevelEnum`	Specifies the compliance level when creating or validating PDF/A documents (as specified in ISO 19005).
`static class`	`OperationConvertPdfa.SuccessReportEnum`	This parameter is used to define whether and in which format the XML report for a successful conversion will be returned

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`JSON_PROPERTY_AUTO_TAGGING`
`static String`	`JSON_PROPERTY_ERROR_CORRECTION`
`static String`	`JSON_PROPERTY_ERROR_REPORT`
`static String`	`JSON_PROPERTY_IMAGE_QUALITY`
`static String`	`JSON_PROPERTY_LEVEL`
`static String`	`JSON_PROPERTY_SUCCESS_REPORT`
`static String`	`JSON_PROPERTY_ZUGFERD`

Constructor Summary

Constructors
Constructor Description

OperationConvertPdfa()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`OperationConvertPdfa`	`autoTagging(Boolean autoTagging)`
`boolean`	`equals(Object o)`
`OperationConvertPdfa`	`errorCorrection(OperationPdfaErrorCorrection errorCorrection)`
`OperationConvertPdfa`	`errorReport(OperationConvertPdfa.ErrorReportEnum errorReport)`
`@Nullable Boolean`	`getAutoTagging()`	In order to convert a document to conformity levels PDF/A 1a-3a, the entire document must have appropriate structure information (tags).
`@Nullable OperationPdfaErrorCorrection`	`getErrorCorrection()`	Get errorCorrection
`@Nullable OperationConvertPdfa.ErrorReportEnum`	`getErrorReport()`	This parameter is used to define whether and in which format the XML report for a failed conversion will be returned
`@Nullable Integer`	`getImageQuality()`	The quality for images which must be transformed during the conversion because they use a compression which is not allowed (e.g.
`@Nullable OperationConvertPdfa.LevelEnum`	`getLevel()`	Specifies the compliance level when creating or validating PDF/A documents (as specified in ISO 19005).
`@Nullable OperationConvertPdfa.SuccessReportEnum`	`getSuccessReport()`	This parameter is used to define whether and in which format the XML report for a successful conversion will be returned
`@Nullable OperationZugferd`	`getZugferd()`	Get zugferd
`int`	`hashCode()`
`OperationConvertPdfa`	`imageQuality(Integer imageQuality)`
`OperationConvertPdfa`	`level(OperationConvertPdfa.LevelEnum level)`
`void`	`setAutoTagging(Boolean autoTagging)`
`void`	`setErrorCorrection(OperationPdfaErrorCorrection errorCorrection)`
`void`	`setErrorReport(OperationConvertPdfa.ErrorReportEnum errorReport)`
`void`	`setImageQuality(Integer imageQuality)`
`void`	`setLevel(OperationConvertPdfa.LevelEnum level)`
`void`	`setSuccessReport(OperationConvertPdfa.SuccessReportEnum successReport)`
`void`	`setZugferd(OperationZugferd zugferd)`
`OperationConvertPdfa`	`successReport(OperationConvertPdfa.SuccessReportEnum successReport)`
`String`	`toString()`
`OperationConvertPdfa`	`zugferd(OperationZugferd zugferd)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - JSON_PROPERTY_AUTO_TAGGING
```
public static final String JSON_PROPERTY_AUTO_TAGGING
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_ERROR_CORRECTION
```
public static final String JSON_PROPERTY_ERROR_CORRECTION
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_ERROR_REPORT
```
public static final String JSON_PROPERTY_ERROR_REPORT
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_IMAGE_QUALITY
```
public static final String JSON_PROPERTY_IMAGE_QUALITY
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_LEVEL
```
public static final String JSON_PROPERTY_LEVEL
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_SUCCESS_REPORT
```
public static final String JSON_PROPERTY_SUCCESS_REPORT
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_ZUGFERD
```
public static final String JSON_PROPERTY_ZUGFERD
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - OperationConvertPdfa
```
public OperationConvertPdfa()
```
- Method Detail
  - autoTagging
```
public OperationConvertPdfa autoTagging(Boolean autoTagging)
```
  - getAutoTagging
```
@Nullable
public @Nullable Boolean getAutoTagging()
```
    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.
    
    Returns:
    
    autoTagging
  - setAutoTagging
```
public void setAutoTagging(Boolean autoTagging)
```
  - errorCorrection
```
public OperationConvertPdfa errorCorrection(OperationPdfaErrorCorrection errorCorrection)
```
  - getErrorCorrection
```
@Nullable
public @Nullable OperationPdfaErrorCorrection getErrorCorrection()
```
    Get errorCorrection
    
    Returns:
    
    errorCorrection
  - setErrorCorrection
```
public void setErrorCorrection(OperationPdfaErrorCorrection errorCorrection)
```
  - errorReport
```
public OperationConvertPdfa errorReport(OperationConvertPdfa.ErrorReportEnum errorReport)
```
  - getErrorReport
```
@Nullable
public @Nullable OperationConvertPdfa.ErrorReportEnum getErrorReport()
```
    This parameter is used to define whether and in which format the XML report for a failed conversion will be returned. * none = An XML report will not be returned * message = The XML report will be returned as part of the error message * file = The XML report will be saved in a file
    
    Returns:
    
    errorReport
  - setErrorReport
```
public void setErrorReport(OperationConvertPdfa.ErrorReportEnum errorReport)
```
  - imageQuality
```
public OperationConvertPdfa imageQuality(Integer imageQuality)
```
  - getImageQuality
```
@Nullable
public @Nullable Integer getImageQuality()
```
    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. minimum: 0 maximum: 100
    
    Returns:
    
    imageQuality
  - setImageQuality
```
public void setImageQuality(Integer imageQuality)
```
  - level
```
public OperationConvertPdfa level(OperationConvertPdfa.LevelEnum level)
```
  - getLevel
```
@Nullable
public @Nullable OperationConvertPdfa.LevelEnum getLevel()
```
    Specifies the compliance level when creating or validating PDF/A documents (as specified in ISO 19005).
    
    Returns:
    
    level
  - setLevel
```
public void setLevel(OperationConvertPdfa.LevelEnum level)
```
  - successReport
```
public OperationConvertPdfa successReport(OperationConvertPdfa.SuccessReportEnum successReport)
```
  - getSuccessReport
```
@Nullable
public @Nullable OperationConvertPdfa.SuccessReportEnum getSuccessReport()
```
    This parameter is used to define whether and in which format the XML report for a successful conversion will be returned. * none = An XML report will not be returned * linked = The XML report will be appended at the end of the PDF/A document. * zip = The PDF/A document and the XML report will be packaged together in a ZIP archive. **Tip:** The format of the document generated with \"errorReport\" and \"successReport\" is described by the http://schema.webpdf.de/1.0/report/pdfa.xsd schema.
    
    Returns:
    
    successReport
  - setSuccessReport
```
public void setSuccessReport(OperationConvertPdfa.SuccessReportEnum successReport)
```
  - zugferd
```
public OperationConvertPdfa zugferd(OperationZugferd zugferd)
```
  - getZugferd
```
@Nullable
public @Nullable OperationZugferd getZugferd()
```
    Get zugferd
    
    Returns:
    
    zugferd
  - setZugferd
```
public void setZugferd(OperationZugferd zugferd)
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class OperationConvertPdfa

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

JSON_PROPERTY_AUTO_TAGGING

JSON_PROPERTY_ERROR_CORRECTION

JSON_PROPERTY_ERROR_REPORT

JSON_PROPERTY_IMAGE_QUALITY

JSON_PROPERTY_LEVEL

JSON_PROPERTY_SUCCESS_REPORT

JSON_PROPERTY_ZUGFERD

Constructor Detail

OperationConvertPdfa

Method Detail

autoTagging

getAutoTagging

setAutoTagging

errorCorrection

getErrorCorrection

setErrorCorrection

errorReport

getErrorReport

setErrorReport

imageQuality

getImageQuality

setImageQuality

level

getLevel

setLevel

successReport

getSuccessReport

setSuccessReport

zugferd

getZugferd

setZugferd

equals

hashCode

toString