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.RESToperation data and may be used as a base to parameterize a webPDF webservice call, to anyWebServiceType.A
RestOperationDataobject is an artificial supporting structure, that would not normally occur in the openapi definition. It exists to create a similar container to theWebServiceProtocol.SOAPspecificOperationDataand allows a similar handling of both protocols via theWebServiceFactory.
-
-
Constructor Summary
Constructors Constructor Description RestOperationData()Prepares a base operation data instance, that may be used to parameterize aWebServiceTypewebPDF webservice call.RestOperationData(@NotNull OperationBarcodeOperation operation)Wraps the givenOperationBarcodeOperationas operation data and may be used as a base to parameterize aWebServiceType.BARCODEwebPDF webservice call.RestOperationData(@NotNull OperationConverterOperation operation)Wraps the givenOperationConverterOperationas operation data and may be used as a base to parameterize aWebServiceType.CONVERTERwebPDF webservice call.RestOperationData(@NotNull OperationOcrOperation operation)Wraps the givenOperationOcrOperationas operation data and may be used as a base to parameterize aWebServiceType.OCRwebPDF webservice call.RestOperationData(@NotNull OperationPdfaOperation operation)Wraps the givenOperationPdfaOperationas operation data and may be used as a base to parameterize aWebServiceType.PDFAwebPDF webservice call.RestOperationData(@NotNull OperationSignatureOperation operation)Wraps the givenOperationSignatureOperationas operation data and may be used as a base to parameterize aWebServiceType.SIGNATUREwebPDF webservice call.RestOperationData(OperationToolboxOperation operation)Wraps the givenOperationToolboxOperationas operation data and may be used as a base to parameterize aWebServiceType.TOOLBOXwebPDF webservice call.RestOperationData(OperationUrlConverterOperation operation)Wraps the givenOperationUrlConverterOperationas operation data and may be used as a base to parameterize aWebServiceType.URLCONVERTERwebPDF webservice call.
-
Method Summary
-
-
-
Constructor Detail
-
RestOperationData
public RestOperationData()
Prepares a base operation data instance, that may be used to parameterize a
WebServiceTypewebPDF webservice call.
-
RestOperationData
public RestOperationData(@NotNull @NotNull OperationConverterOperation operation)Wraps the given
OperationConverterOperationas operation data and may be used as a base to parameterize aWebServiceType.CONVERTERwebPDF webservice call.- Parameters:
operation- TheOperationConverterOperationto wrap.
-
RestOperationData
public RestOperationData(@NotNull @NotNull OperationBarcodeOperation operation)Wraps the given
OperationBarcodeOperationas operation data and may be used as a base to parameterize aWebServiceType.BARCODEwebPDF webservice call.- Parameters:
operation- TheOperationBarcodeOperationto wrap.
-
RestOperationData
public RestOperationData(@NotNull @NotNull OperationOcrOperation operation)Wraps the given
OperationOcrOperationas operation data and may be used as a base to parameterize aWebServiceType.OCRwebPDF webservice call.- Parameters:
operation- TheOperationOcrOperationto wrap.
-
RestOperationData
public RestOperationData(@NotNull @NotNull OperationPdfaOperation operation)Wraps the givenOperationPdfaOperationas operation data and may be used as a base to parameterize aWebServiceType.PDFAwebPDF webservice call.
-
RestOperationData
public RestOperationData(@NotNull @NotNull OperationSignatureOperation operation)Wraps the given
OperationSignatureOperationas operation data and may be used as a base to parameterize aWebServiceType.SIGNATUREwebPDF webservice call.- Parameters:
operation- TheOperationSignatureOperationto wrap.
-
RestOperationData
public RestOperationData(OperationToolboxOperation operation)
Wraps the given
OperationToolboxOperationas operation data and may be used as a base to parameterize aWebServiceType.TOOLBOXwebPDF webservice call.This may contain the following operations:
OperationToolboxAnnotationAnnotationOperationToolboxAttachmentAttachmentOperationToolboxDeleteDeleteOperationToolboxDescriptionDescriptionOperationToolboxExtractionExtractionOperationToolboxFormsFormsOperationToolboxImageImageOperationToolboxMergeMergeOperationToolboxOptionsOptionsOperationToolboxPrintPrintOperationToolboxRotateRotateOperationToolboxSecuritySecurityOperationToolboxSplitSplitOperationToolboxWatermarkWatermarkOperationToolboxXmpXmpOperationToolboxMoveMoveOperationToolboxOutlineOutlineOperationToolboxRedactRedactOperationToolboxPortfolioPortfolioOperationToolboxScaleScaleOperationToolboxCompressCompressOperationToolboxTranscribeTranscribe
- Parameters:
operation- TheOperationToolboxOperationto wrap.
-
RestOperationData
public RestOperationData(OperationUrlConverterOperation operation)
Wraps the given
OperationUrlConverterOperationas operation data and may be used as a base to parameterize aWebServiceType.URLCONVERTERwebPDF webservice call.- Parameters:
operation- TheOperationUrlConverterOperationto wrap.
-
-
Method Detail
-
getBilling
@Nullable public @Nullable OperationBilling getBilling()
Returns theOperationBillingsettings set for thisRestOperationData.- Returns:
- The
OperationBillingsettings set for thisRestOperationData.
-
setBilling
public void setBilling(@Nullable @Nullable OperationBilling value)Sets theOperationBillingsettings for thisRestOperationData.- Parameters:
value- TheOperationBillingsettings for thisRestOperationData.
-
isSetBilling
public boolean isSetBilling()
- Returns:
trueshould the setOperationBillingnot benull.- See Also:
setBilling(OperationBilling),getBilling()
-
getPassword
@Nullable public @Nullable OperationPdfPassword getPassword()
Returns theOperationPdfPasswordsettings set for thisRestOperationData.- Returns:
- The
OperationPdfPasswordsettings set for thisRestOperationData.
-
setPassword
public void setPassword(@Nullable @Nullable OperationPdfPassword value)Sets theOperationPdfPasswordsettings for thisRestOperationData.- Parameters:
value- TheOperationPdfPasswordsettings for thisRestOperationData.
-
isSetPassword
public boolean isSetPassword()
- Returns:
trueshould the setOperationPdfPasswordnot benull.- See Also:
setPassword(OperationPdfPassword),()
-
getSettings
@Nullable public @Nullable OperationSettings getSettings()
Returns theOperationSettingssettings set for thisRestOperationData.- Returns:
- The
OperationSettingssettings set for thisRestOperationData.
-
setSettings
public void setSettings(@Nullable @Nullable OperationSettings value)Sets theOperationSettingssettings for thisRestOperationData.- Parameters:
value- TheOperationSettingssettings for thisRestOperationData.
-
isSetSettings
public boolean isSetSettings()
- Returns:
trueshould the setOperationSettingsnot benull.- See Also:
setSettings(OperationSettings),getSettings()
-
getBarcode
@Nullable public @Nullable OperationBarcode getBarcode()
Returns theOperationBarcodeset for thisRestOperationData.- Returns:
- The
OperationBarcodeset for thisRestOperationData.
-
setBarcode
public void setBarcode(@Nullable @Nullable OperationBarcode value)Sets theOperationBarcodefor thisRestOperationData.- Parameters:
value- TheOperationBarcodefor thisRestOperationData.
-
isSetBarcode
public boolean isSetBarcode()
- Returns:
trueshould the setOperationBarcodenot benull.- See Also:
setBarcode(OperationBarcode),getBarcode()
-
getConverter
@Nullable public @Nullable OperationConverter getConverter()
Returns theOperationConverterset for thisRestOperationData.- Returns:
- The
OperationConverterset for thisRestOperationData.
-
setConverter
public void setConverter(@Nullable @Nullable OperationConverter value)Sets theOperationConverterfor thisRestOperationData.- Parameters:
value- TheOperationConverterfor thisRestOperationData.
-
isSetConverter
public boolean isSetConverter()
- Returns:
trueshould the setOperationConverternot benull.- See Also:
setConverter(OperationConverter),getConverter()
-
getOcr
@Nullable public @Nullable OperationOcr getOcr()
Returns theOperationOcrset for thisRestOperationData.- Returns:
- The
OperationOcrset for thisRestOperationData.
-
setOcr
public void setOcr(@Nullable @Nullable OperationOcr value)Sets theOperationOcrfor thisRestOperationData.- Parameters:
value- TheOperationOcrfor thisRestOperationData.
-
isSetOcr
public boolean isSetOcr()
- Returns:
trueshould the setOperationOcrnot benull.- See Also:
setOcr(OperationOcr),getOcr()
-
getPdfa
@Nullable public @Nullable OperationPdfa getPdfa()
Returns theOperationPdfaset for thisRestOperationData.- Returns:
- The
OperationPdfaset for thisRestOperationData.
-
setPdfa
public void setPdfa(@Nullable @Nullable OperationPdfa value)Sets theOperationPdfafor thisRestOperationData.- Parameters:
value- TheOperationPdfafor thisRestOperationData.
-
isSetPdfa
public boolean isSetPdfa()
- Returns:
trueshould the setOperationPdfanot benull.- See Also:
setPdfa(OperationPdfa),getPdfa()
-
getSignature
@Nullable public @Nullable OperationSignature getSignature()
Returns theOperationSignatureset for thisRestOperationData.- Returns:
- The
OperationSignatureset for thisRestOperationData.
-
setSignature
public void setSignature(@Nullable @Nullable OperationSignature value)Sets theOperationSignaturefor thisRestOperationData.- Parameters:
value- TheOperationSignaturefor thisRestOperationData.
-
isSetSignature
public boolean isSetSignature()
- Returns:
trueshould the setOperationSignaturenot benull.- See Also:
setSignature(OperationSignature),getSignature()
-
getToolbox
@NotNull public @NotNull List<OperationBaseToolbox> getToolbox()
Returns the
OperationBaseToolboxlist set for thisRestOperationData.This may contain the following operations:
OperationToolboxAnnotationAnnotationOperationToolboxAttachmentAttachmentOperationToolboxDeleteDeleteOperationToolboxDescriptionDescriptionOperationToolboxExtractionExtractionOperationToolboxFormsFormsOperationToolboxImageImageOperationToolboxMergeMergeOperationToolboxOptionsOptionsOperationToolboxPrintPrintOperationToolboxRotateRotateOperationToolboxSecuritySecurityOperationToolboxSplitSplitOperationToolboxWatermarkWatermarkOperationToolboxXmpXmpOperationToolboxMoveMoveOperationToolboxOutlineOutlineOperationToolboxRedactRedactOperationToolboxPortfolioPortfolioOperationToolboxScaleScaleOperationToolboxCompressCompressOperationToolboxTranscribeTranscribe
- Returns:
- The
OperationSignaturelist set for thisRestOperationData.
-
setToolbox
public void setToolbox(@Nullable @Nullable List<OperationBaseToolbox> value)Sets the
OperationBaseToolboxlist for thisRestOperationData.This may contain the following operations:
OperationToolboxAnnotationAnnotationOperationToolboxAttachmentAttachmentOperationToolboxDeleteDeleteOperationToolboxDescriptionDescriptionOperationToolboxExtractionExtractionOperationToolboxFormsFormsOperationToolboxImageImageOperationToolboxMergeMergeOperationToolboxOptionsOptionsOperationToolboxPrintPrintOperationToolboxRotateRotateOperationToolboxSecuritySecurityOperationToolboxSplitSplitOperationToolboxWatermarkWatermarkOperationToolboxXmpXmpOperationToolboxMoveMoveOperationToolboxOutlineOutlineOperationToolboxRedactRedactOperationToolboxPortfolioPortfolioOperationToolboxScaleScaleOperationToolboxCompressCompressOperationToolboxTranscribeTranscribe
- Parameters:
value- TheOperationBaseToolboxlist for thisRestOperationData.
-
isSetToolbox
public boolean isSetToolbox()
- Returns:
trueshould the setOperationBaseToolboxnot benullorempty.- See Also:
setToolbox(List),getToolbox()
-
getUrlconverter
@Nullable public @Nullable OperationUrlConverter getUrlconverter()
Returns theOperationUrlConverterset for thisRestOperationData.- Returns:
- The
OperationUrlConverterset for thisRestOperationData.
-
setUrlconverter
public void setUrlconverter(@Nullable @Nullable OperationUrlConverter value)Sets theOperationUrlConverterfor thisRestOperationData.- Parameters:
value- TheOperationUrlConverterfor thisRestOperationData.
-
isSetUrlconverter
public boolean isSetUrlconverter()
- Returns:
trueshould the setOperationUrlConverternot benull.- See Also:
setUrlconverter(OperationUrlConverter),getUrlconverter()
-
-