Package net.webpdf.wsclient.openapi

Class RestOperationData

java.lang.Object

net.webpdf.wsclient.openapi.RestOperationData

public class RestOperationData
extends Object

An instance of this class wraps some sort of WebServiceProtocol.REST operation data and may be used as a base to parameterize a webPDF webservice call, to any WebServiceType.

A RestOperationData object is an artificial supporting structure, that would not normally occur in the openapi definition. It exists to create a similar container to the WebServiceProtocol.SOAP specific OperationData and allows a similar handling of both protocols via the WebServiceFactory.

Constructor Summary

Constructors

Constructor	Description
RestOperationData()	Prepares a base operation data instance, that may be used to parameterize a WebServiceType webPDF webservice call.
RestOperationData(@NotNull OperationBarcodeOperation operation)	Wraps the given OperationBarcodeOperation as operation data and may be used as a base to parameterize a WebServiceType.BARCODE webPDF webservice call.
RestOperationData(@NotNull OperationConverterOperation operation)	Wraps the given OperationConverterOperation as operation data and may be used as a base to parameterize a WebServiceType.CONVERTER webPDF webservice call.
RestOperationData(@NotNull OperationOcrOperation operation)	Wraps the given OperationOcrOperation as operation data and may be used as a base to parameterize a WebServiceType.OCR webPDF webservice call.
RestOperationData(@NotNull OperationPdfaOperation operation)	Wraps the given OperationPdfaOperation as operation data and may be used as a base to parameterize a WebServiceType.PDFA webPDF webservice call.
RestOperationData(@NotNull OperationSignatureOperation operation)	Wraps the given OperationSignatureOperation as operation data and may be used as a base to parameterize a WebServiceType.SIGNATURE webPDF webservice call.
RestOperationData(OperationToolboxOperation operation)	Wraps the given OperationToolboxOperation as operation data and may be used as a base to parameterize a WebServiceType.TOOLBOX webPDF webservice call.
RestOperationData(OperationUrlConverterOperation operation)	Wraps the given OperationUrlConverterOperation as operation data and may be used as a base to parameterize a WebServiceType.URLCONVERTER webPDF webservice call.

Method Summary

Modifier and Type	Method	Description
@Nullable OperationBarcode	getBarcode()	Returns the OperationBarcode set for this RestOperationData.
@Nullable OperationBilling	getBilling()	Returns the OperationBilling settings set for this RestOperationData.
@Nullable OperationConverter	getConverter()	Returns the OperationConverter set for this RestOperationData.
@Nullable OperationOcr	getOcr()	Returns the OperationOcr set for this RestOperationData.
@Nullable OperationPdfPassword	getPassword()	Returns the OperationPdfPassword settings set for this RestOperationData.
@Nullable OperationPdfa	getPdfa()	Returns the OperationPdfa set for this RestOperationData.
@Nullable OperationSettings	getSettings()	Returns the OperationSettings settings set for this RestOperationData.
@Nullable OperationSignature	getSignature()	Returns the OperationSignature set for this RestOperationData.
@NotNull List<OperationBaseToolbox>	getToolbox()	Returns the OperationBaseToolbox list set for this RestOperationData.
@Nullable OperationUrlConverter	getUrlconverter()	Returns the OperationUrlConverter set for this RestOperationData.
boolean	isSetBarcode()	Returns true should the set OperationBarcode not be null.
boolean	isSetBilling()	Returns true should the set OperationBilling not be null.
boolean	isSetConverter()	Returns true should the set OperationConverter not be null.
boolean	isSetOcr()	Returns true should the set OperationOcr not be null.
boolean	isSetPassword()	Returns true should the set OperationPdfPassword not be null.
boolean	isSetPdfa()	Returns true should the set OperationPdfa not be null.
boolean	isSetSettings()	Returns true should the set OperationSettings not be null.
boolean	isSetSignature()	Returns true should the set OperationSignature not be null.
boolean	isSetToolbox()	Returns true should the set OperationBaseToolbox list not be null or empty.
boolean	isSetUrlconverter()	Returns true should the set OperationUrlConverter not be null.
void	setBarcode(@Nullable OperationBarcode value)	Sets the OperationBarcode for this RestOperationData.
void	setBilling(@Nullable OperationBilling value)	Sets the OperationBilling settings for this RestOperationData.
void	setConverter(@Nullable OperationConverter value)	Sets the OperationConverter for this RestOperationData.
void	setOcr(@Nullable OperationOcr value)	Sets the OperationOcr for this RestOperationData.
void	setPassword(@Nullable OperationPdfPassword value)	Sets the OperationPdfPassword settings for this RestOperationData.
void	setPdfa(@Nullable OperationPdfa value)	Sets the OperationPdfa for this RestOperationData.
void	setSettings(@Nullable OperationSettings value)	Sets the OperationSettings settings for this RestOperationData.
void	setSignature(@Nullable OperationSignature value)	Sets the OperationSignature for this RestOperationData.
void	setToolbox(@Nullable List<OperationBaseToolbox> value)	Sets the OperationBaseToolbox list for this RestOperationData.
void	setUrlconverter(@Nullable OperationUrlConverter value)	Sets the OperationUrlConverter for this RestOperationData.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RestOperationData

public RestOperationData()

Prepares a base operation data instance, that may be used to parameterize a WebServiceType webPDF webservice call.

RestOperationData

public RestOperationData(@NotNull
                         @NotNull OperationConverterOperation operation)

Wraps the given OperationConverterOperation as operation data and may be used as a base to parameterize a WebServiceType.CONVERTER webPDF webservice call.

Parameters:

operation - The OperationConverterOperation to wrap.

RestOperationData

public RestOperationData(@NotNull
                         @NotNull OperationBarcodeOperation operation)

Wraps the given OperationBarcodeOperation as operation data and may be used as a base to parameterize a WebServiceType.BARCODE webPDF webservice call.

Parameters:

operation - The OperationBarcodeOperation to wrap.

RestOperationData

public RestOperationData(@NotNull
                         @NotNull OperationOcrOperation operation)

Wraps the given OperationOcrOperation as operation data and may be used as a base to parameterize a WebServiceType.OCR webPDF webservice call.

Parameters:

operation - The OperationOcrOperation to wrap.

RestOperationData

public RestOperationData(@NotNull
                         @NotNull OperationPdfaOperation operation)

Wraps the given OperationPdfaOperation as operation data and may be used as a base to parameterize a WebServiceType.PDFA webPDF webservice call.

RestOperationData

public RestOperationData(@NotNull
                         @NotNull OperationSignatureOperation operation)

Wraps the given OperationSignatureOperation as operation data and may be used as a base to parameterize a WebServiceType.SIGNATURE webPDF webservice call.

Parameters:

operation - The OperationSignatureOperation to wrap.

RestOperationData

public RestOperationData(OperationToolboxOperation operation)

Wraps the given OperationToolboxOperation as operation data and may be used as a base to parameterize a WebServiceType.TOOLBOX webPDF webservice call.

This may contain the following operations:

• OperationToolboxAnnotationAnnotation
• OperationToolboxAttachmentAttachment
• OperationToolboxDeleteDelete
• OperationToolboxDescriptionDescription
• OperationToolboxExtractionExtraction
• OperationToolboxFormsForms
• OperationToolboxImageImage
• OperationToolboxMergeMerge
• OperationToolboxOptionsOptions
• OperationToolboxPrintPrint
• OperationToolboxRotateRotate
• OperationToolboxSecuritySecurity
• OperationToolboxSplitSplit
• OperationToolboxWatermarkWatermark
• OperationToolboxXmpXmp
• OperationToolboxMoveMove
• OperationToolboxOutlineOutline
• OperationToolboxRedactRedact
• OperationToolboxPortfolioPortfolio
• OperationToolboxScaleScale
• OperationToolboxCompressCompress
• OperationToolboxTranscribeTranscribe

Parameters:

operation - The OperationToolboxOperation to wrap.

RestOperationData

public RestOperationData(OperationUrlConverterOperation operation)

Wraps the given OperationUrlConverterOperation as operation data and may be used as a base to parameterize a WebServiceType.URLCONVERTER webPDF webservice call.

Parameters:

operation - The OperationUrlConverterOperation to wrap.

Method Detail

getBilling

@Nullable
public @Nullable OperationBilling getBilling()

Returns the OperationBilling settings set for this RestOperationData.

Returns:

The OperationBilling settings set for this RestOperationData.

setBilling

public void setBilling(@Nullable
                       @Nullable OperationBilling value)

Sets the OperationBilling settings for this RestOperationData.

Parameters:

value - The OperationBilling settings for this RestOperationData.

isSetBilling

public boolean isSetBilling()

Returns true should the set OperationBilling not be null.

Returns:

true should the set OperationBilling not be null.

See Also:

setBilling(OperationBilling), getBilling()

getPassword

@Nullable
public @Nullable OperationPdfPassword getPassword()

Returns the OperationPdfPassword settings set for this RestOperationData.

Returns:

The OperationPdfPassword settings set for this RestOperationData.

setPassword

public void setPassword(@Nullable
                        @Nullable OperationPdfPassword value)

Sets the OperationPdfPassword settings for this RestOperationData.

Parameters:

value - The OperationPdfPassword settings for this RestOperationData.

isSetPassword

public boolean isSetPassword()

Returns true should the set OperationPdfPassword not be null.

Returns:

true should the set OperationPdfPassword not be null.

See Also:

setPassword(OperationPdfPassword), ()

getSettings

@Nullable
public @Nullable OperationSettings getSettings()

Returns the OperationSettings settings set for this RestOperationData.

Returns:

The OperationSettings settings set for this RestOperationData.

setSettings

public void setSettings(@Nullable
                        @Nullable OperationSettings value)

Sets the OperationSettings settings for this RestOperationData.

Parameters:

value - The OperationSettings settings for this RestOperationData.

isSetSettings

public boolean isSetSettings()

Returns true should the set OperationSettings not be null.

Returns:

true should the set OperationSettings not be null.

See Also:

setSettings(OperationSettings), getSettings()

getBarcode

@Nullable
public @Nullable OperationBarcode getBarcode()

Returns the OperationBarcode set for this RestOperationData.

Returns:

The OperationBarcode set for this RestOperationData.

setBarcode

public void setBarcode(@Nullable
                       @Nullable OperationBarcode value)

Sets the OperationBarcode for this RestOperationData.

Parameters:

value - The OperationBarcode for this RestOperationData.

isSetBarcode

public boolean isSetBarcode()

Returns true should the set OperationBarcode not be null.

Returns:

true should the set OperationBarcode not be null.

See Also:

setBarcode(OperationBarcode), getBarcode()

getConverter

@Nullable
public @Nullable OperationConverter getConverter()

Returns the OperationConverter set for this RestOperationData.

Returns:

The OperationConverter set for this RestOperationData.

setConverter

public void setConverter(@Nullable
                         @Nullable OperationConverter value)

Sets the OperationConverter for this RestOperationData.

Parameters:

value - The OperationConverter for this RestOperationData.

isSetConverter

public boolean isSetConverter()

Returns true should the set OperationConverter not be null.

Returns:

true should the set OperationConverter not be null.

See Also:

setConverter(OperationConverter), getConverter()

getOcr

@Nullable
public @Nullable OperationOcr getOcr()

Returns the OperationOcr set for this RestOperationData.

Returns:

The OperationOcr set for this RestOperationData.

setOcr

public void setOcr(@Nullable
                   @Nullable OperationOcr value)

Sets the OperationOcr for this RestOperationData.

Parameters:

value - The OperationOcr for this RestOperationData.

isSetOcr

public boolean isSetOcr()

Returns true should the set OperationOcr not be null.

Returns:

true should the set OperationOcr not be null.

See Also:

setOcr(OperationOcr), getOcr()

getPdfa

@Nullable
public @Nullable OperationPdfa getPdfa()

Returns the OperationPdfa set for this RestOperationData.

Returns:

The OperationPdfa set for this RestOperationData.

setPdfa

public void setPdfa(@Nullable
                    @Nullable OperationPdfa value)

Sets the OperationPdfa for this RestOperationData.

Parameters:

value - The OperationPdfa for this RestOperationData.

isSetPdfa

public boolean isSetPdfa()

Returns true should the set OperationPdfa not be null.

Returns:

true should the set OperationPdfa not be null.

See Also:

setPdfa(OperationPdfa), getPdfa()

getSignature

@Nullable
public @Nullable OperationSignature getSignature()

Returns the OperationSignature set for this RestOperationData.

Returns:

The OperationSignature set for this RestOperationData.

setSignature

public void setSignature(@Nullable
                         @Nullable OperationSignature value)

Sets the OperationSignature for this RestOperationData.

Parameters:

value - The OperationSignature for this RestOperationData.

isSetSignature

public boolean isSetSignature()

Returns true should the set OperationSignature not be null.

Returns:

true should the set OperationSignature not be null.

See Also:

setSignature(OperationSignature), getSignature()

getToolbox

@NotNull
public @NotNull List<OperationBaseToolbox> getToolbox()

Returns the OperationBaseToolbox list set for this RestOperationData.

This may contain the following operations:

• OperationToolboxAnnotationAnnotation
• OperationToolboxAttachmentAttachment
• OperationToolboxDeleteDelete
• OperationToolboxDescriptionDescription
• OperationToolboxExtractionExtraction
• OperationToolboxFormsForms
• OperationToolboxImageImage
• OperationToolboxMergeMerge
• OperationToolboxOptionsOptions
• OperationToolboxPrintPrint
• OperationToolboxRotateRotate
• OperationToolboxSecuritySecurity
• OperationToolboxSplitSplit
• OperationToolboxWatermarkWatermark
• OperationToolboxXmpXmp
• OperationToolboxMoveMove
• OperationToolboxOutlineOutline
• OperationToolboxRedactRedact
• OperationToolboxPortfolioPortfolio
• OperationToolboxScaleScale
• OperationToolboxCompressCompress
• OperationToolboxTranscribeTranscribe

Returns:

The OperationSignature list set for this RestOperationData.

setToolbox

public void setToolbox(@Nullable
                       @Nullable List<OperationBaseToolbox> value)

Sets the OperationBaseToolbox list for this RestOperationData.

This may contain the following operations:

• OperationToolboxAnnotationAnnotation
• OperationToolboxAttachmentAttachment
• OperationToolboxDeleteDelete
• OperationToolboxDescriptionDescription
• OperationToolboxExtractionExtraction
• OperationToolboxFormsForms
• OperationToolboxImageImage
• OperationToolboxMergeMerge
• OperationToolboxOptionsOptions
• OperationToolboxPrintPrint
• OperationToolboxRotateRotate
• OperationToolboxSecuritySecurity
• OperationToolboxSplitSplit
• OperationToolboxWatermarkWatermark
• OperationToolboxXmpXmp
• OperationToolboxMoveMove
• OperationToolboxOutlineOutline
• OperationToolboxRedactRedact
• OperationToolboxPortfolioPortfolio
• OperationToolboxScaleScale
• OperationToolboxCompressCompress
• OperationToolboxTranscribeTranscribe

Parameters:

value - The OperationBaseToolbox list for this RestOperationData.

isSetToolbox

public boolean isSetToolbox()

Returns true should the set OperationBaseToolbox list not be null or empty.

Returns:

true should the set OperationBaseToolbox not be null or empty.

See Also:

setToolbox(List), getToolbox()

getUrlconverter

@Nullable
public @Nullable OperationUrlConverter getUrlconverter()

Returns the OperationUrlConverter set for this RestOperationData.

Returns:

The OperationUrlConverter set for this RestOperationData.

setUrlconverter

public void setUrlconverter(@Nullable
                            @Nullable OperationUrlConverter value)

Sets the OperationUrlConverter for this RestOperationData.

Parameters:

value - The OperationUrlConverter for this RestOperationData.

isSetUrlconverter

public boolean isSetUrlconverter()

Returns true should the set OperationUrlConverter not be null.

Returns:

true should the set OperationUrlConverter not be null.

See Also:

setUrlconverter(OperationUrlConverter), getUrlconverter()