Package net.webpdf.wsclient.webservice.rest

Class OcrRestWebService<T_REST_DOCUMENT extends RestDocument>

java.lang.Object

net.webpdf.wsclient.webservice.AbstractWebService<RestSession<T_REST_DOCUMENT>,T_OPERATION_DATA,T_OPERATION_PARAMETER,T_REST_DOCUMENT,OperationBilling,OperationPdfPassword,OperationSettings>

net.webpdf.wsclient.webservice.rest.RestWebService<OperationOcrOperation,OperationOcr,T_REST_DOCUMENT>

net.webpdf.wsclient.webservice.rest.OcrRestWebService<T_REST_DOCUMENT>

Type Parameters:

T_REST_DOCUMENT - The expected RestDocument type for the documents used by the webPDF server.

All Implemented Interfaces:

WebService<RestSession<T_REST_DOCUMENT>,OperationOcr,T_REST_DOCUMENT,OperationBilling,OperationPdfPassword,OperationSettings>

public class OcrRestWebService<T_REST_DOCUMENT extends RestDocument>
extends RestWebService<OperationOcrOperation,OperationOcr,T_REST_DOCUMENT>

An instance of OcrRestWebService wraps a wsclient connection to the webPDF webservice endpoint WebServiceType.OCR, using WebServiceProtocol.REST and expecting a RestDocument as the result.

Constructor Summary

Constructors

Constructor	Description
OcrRestWebService(@NotNull RestSession<T_REST_DOCUMENT> session)	Creates a OcrRestWebService for the given RestSession

Method Summary

Modifier and Type	Method	Description
@Nullable OperationBilling	getBilling()	Returns the OperationBilling of the current webservice.
@NotNull OperationOcr	getOperationParameters()	Returns the OcrRestWebService specific OperationOcr, which allows setting parameters for the webservice execution.
@Nullable OperationPdfPassword	getPassword()	Returns the OperationPdfPassword of the current webservice.
@Nullable OperationSettings	getSettings()	Returns the OperationSettings of the current webservice.
protected @NotNull OperationOcrOperation	initOperation()	Initializes and prepares the execution of this OcrRestWebService.
void	setBilling(@Nullable OperationBilling billing)	Sets the OperationBilling for the current webservice.
void	setOperationParameters(@Nullable OperationOcr operation)	Sets the OcrRestWebService specific OperationOcr element, which allows setting parameters for the webservice execution.
void	setPassword(@Nullable OperationPdfPassword password)	Sets the OperationPdfPassword for the current webservice.
void	setSettings(@Nullable OperationSettings settings)	Sets the OperationSettings for the current webservice.

Methods inherited from class net.webpdf.wsclient.webservice.rest.RestWebService

process, process, process

Methods inherited from class net.webpdf.wsclient.webservice.AbstractWebService

getAdditionalParameter, getHeaders, getOperationData, getSession, getWebServiceType

Methods inherited from class java.lang.Object

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

Constructor Detail

OcrRestWebService

public OcrRestWebService(@NotNull
                         @NotNull RestSession<T_REST_DOCUMENT> session)

Creates a OcrRestWebService for the given RestSession

Parameters:

session - The RestSession a OcrRestWebService shall be created for.

Method Detail

getOperationParameters

@NotNull
public @NotNull OperationOcr getOperationParameters()

Returns the OcrRestWebService specific OperationOcr, which allows setting parameters for the webservice execution.

Returns:

The OperationOcr operation parameters.

setOperationParameters

public void setOperationParameters(@Nullable
                                   @Nullable OperationOcr operation)

Sets the OcrRestWebService specific OperationOcr element, which allows setting parameters for the webservice execution.

Parameters:

operation - Sets the OperationOcr operation parameters.

getPassword

@Nullable
public @Nullable OperationPdfPassword getPassword()

Returns the OperationPdfPassword of the current webservice.

Returns:

the OperationPdfPassword of the current webservice.

setPassword

public void setPassword(@Nullable
                        @Nullable OperationPdfPassword password)

Sets the OperationPdfPassword for the current webservice.

Parameters:

password - The OperationPdfPassword for the current webservice.

getBilling

@Nullable
public @Nullable OperationBilling getBilling()

Returns the OperationBilling of the current webservice.

Returns:

the OperationBilling of the current webservice.

setBilling

public void setBilling(@Nullable
                       @Nullable OperationBilling billing)

Sets the OperationBilling for the current webservice.

Parameters:

billing - The OperationBilling for the current webservice.

getSettings

@Nullable
public @Nullable OperationSettings getSettings()

Returns the OperationSettings of the current webservice.

Returns:

the OperationSettings of the current webservice.

setSettings

public void setSettings(@Nullable
                        @Nullable OperationSettings settings)

Sets the OperationSettings for the current webservice.

Parameters:

settings - The OperationSettings for the current webservice.

initOperation

@NotNull
protected @NotNull OperationOcrOperation initOperation()

Initializes and prepares the execution of this OcrRestWebService.

Specified by:

initOperation in class AbstractWebService<RestSession<T_REST_DOCUMENT extends RestDocument>,OperationOcrOperation,OperationOcr,T_REST_DOCUMENT extends RestDocument,OperationBilling,OperationPdfPassword,OperationSettings>

Returns:

The prepared OperationOcrOperation.