net.webpdf.wsclient

Interface WebService<T_DOC extends Document,T_OPERATION_TYPE,T_RESULT>

Type Parameters:

T_DOC - Document which contains source and target resource

T_OPERATION_TYPE - Webservice specific operation type

T_RESULT - The result type

All Known Implementing Classes:

BarcodeRestWebService, BarcodeWebService, ConverterRestWebService, ConverterWebService, OcrRestWebService, OcrWebService, PdfaRestWebService, PdfaWebService, RestWebservice, SignatureRestWebService, SignatureWebService, SoapWebService, ToolboxRestWebService, ToolboxWebService, UrlConverterRestWebService, UrlConverterWebService

public interface WebService<T_DOC extends Document,T_OPERATION_TYPE,T_RESULT>

Method Summary

Modifier and Type	Method and Description
@NotNull BillingType	getBilling() Returns the BillingType from the webservice specific operation This is the functional part and webservice specific.
T_DOC	getDocument() Get the document which contains the source
T_OPERATION_TYPE	getOperation() Get webservice specific operation element to set webservice specific parameters
@NotNull PdfPasswordType	getPassword() Returns the PdfPasswordType from the webservice specific operation
T_RESULT	process() Execute webservice operation and returns result
void	setDocument(T_DOC document) Set the document which contains the source
void	setOperation(T_OPERATION_TYPE operationData) Sets the web service operation data

Method Detail

process

@Nullable
T_RESULT process()
                     throws ResultException

Execute webservice operation and returns result

Returns:

the result

Throws:

ResultException - an ResultException

getOperation

@Nullable
T_OPERATION_TYPE getOperation()

Get webservice specific operation element to set webservice specific parameters

Returns:

operation type element

setOperation

void setOperation(@Nullable
                  T_OPERATION_TYPE operationData)
           throws ResultException

Sets the web service operation data

Parameters:

operationData - the web service operation data

Throws:

ResultException - an ResultException

getDocument

@Nullable
T_DOC getDocument()

Get the document which contains the source

Returns:

document which contains the source

setDocument

void setDocument(@Nullable
                 T_DOC document)

Set the document which contains the source

Parameters:

document - document which contains the source

getPassword

@NotNull
@NotNull PdfPasswordType getPassword()

Returns the PdfPasswordType from the webservice specific operation

Returns:

the PdfPasswordType from the webservice specific operation

getBilling

@NotNull
@NotNull BillingType getBilling()

Returns the BillingType from the webservice specific operation This is the functional part and webservice specific. For the common operation parts billing and password call getBilling and getPassword

Returns:

the BillingType from the webservice specific operation