com.sap.tc.webdynpro.pdfobject.api

Interface IWDPDFObject

public interface IWDPDFObject

Interface IWDPDFObject describes the public interface of the PDFObject API. Please refrain from using IWDPDFObject API to create/manipulate PDF document. Instead, make use of IWDPDFdocument for all such purposes. All the methods in IWDPDFObject API has been deprecated to stop any further use of the API. Gradually, this interface will be removed from the public API and will solely be used by the framework classes.

Type Classification:

This interface is part of the Web Dynpro API, so applications may reference it or call any method of it, but they must not implement or extend it.

For a detailed explanation of API classification see the Web Dynpro Compatibility Guide

Method Summary

InputStream	certify(String credential, String fieldName, String reason, String location, String contactInfo, String legalAttestations, String permissionMode) Deprecated. Make use of IWDPDFDocument interface instead
void	changesNotAllowed(boolean changesNotAllowed) Deprecated. Make use of IWDPDFDocument interface instead
InputStream	createPDF() Deprecated. Make use of IWDPDFDocument interface instead
boolean	createPDF(String url) Deprecated. Make use of IWDPDFDocument interface instead
InputStream	createPDL() Deprecated. Make use of IWDPDFDocument interface instead
boolean	createPDL(String url) Deprecated. Make use of IWDPDFDocument interface instead
String	getApplicationName() Deprecated. Make use of IWDPDFDocument interface instead
boolean	getCertification() Deprecated. Make use of IWDPDFDocument interface instead
String	getClientID() Deprecated. Make use of IWDPDFDocument interface instead
InputStream	getColumnData() Deprecated. Make use of IWDPDFDocument interface instead
boolean	getColumnData(String url) Deprecated. Make use of IWDPDFDocument interface instead
InputStream	getData() Deprecated. Make use of IWDPDFDocument interface instead
boolean	getData(String url) Deprecated. Make use of IWDPDFDocument interface instead
String	getFormName() Deprecated. Make use of IWDPDFDocument interface instead
InputStream	getPDL() Deprecated. Make use of IWDPDFDocument interface instead
boolean	getPDL(String url) Deprecated. Make use of IWDPDFDocument interface instead
String	getResultString() Deprecated. Make use of IWDPDFDocument interface instead
InputStream	getReviewCopy() Deprecated. Make use of IWDPDFDocument interface instead
boolean	getReviewCopy(String url) Deprecated. Make use of IWDPDFDocument interface instead
void	setApplicationName(String applicationName) Deprecated. Make use of IWDPDFDocument interface instead
void	setBaseURI(String url) Deprecated. Make use of IWDPDFDocument interface instead
void	setClientID(String clientID) Deprecated. Make use of IWDPDFDocument interface instead
void	setConfigURL(String URL) Deprecated. Make use of IWDPDFDocument interface instead
void	setData(OutputStream xfd) Deprecated. Make use of IWDPDFDocument interface instead
void	setData(String url) Deprecated. Make use of IWDPDFDocument interface instead
void	setDestination(String destination) Deprecated. Make use of IWDPDFDocument interface instead
void	setDynamicPDF(boolean dynamicPDF) Deprecated. Make use of IWDPDFDocument interface instead
void	setFormName(String formName) Deprecated. Make use of IWDPDFDocument interface instead
void	setInteractive(boolean b) Deprecated. Make use of IWDPDFDocument interface instead
void	setLocale(Locale locale) Deprecated. Make use of IWDPDFDocument interface instead
void	setPDF(ByteArrayOutputStream pdf) Deprecated. Make use of IWDPDFDocument interface instead
void	setPDF(String url) Deprecated. Make use of IWDPDFDocument interface instead
void	setPDLType(String pdlType) Deprecated. Make use of IWDPDFDocument interface instead
void	setSecureCommunication(boolean b) Deprecated. Make use of IWDPDFDocument interface instead
void	setSecurity(List certificates, boolean printable, boolean fillable, boolean changeable, boolean extractable) Deprecated. Make use of IWDPDFDocument interface instead
void	setTemplate(OutputStream template) Deprecated. Make use of IWDPDFDocument interface instead
void	setTemplate(String url) Deprecated. Make use of IWDPDFDocument interface instead
void	setUsageRights(String credential, WDUsageRight[] rights) Deprecated. Make use of IWDPDFDocument interface instead
void	setUserName(String userName) Deprecated. Make use of IWDPDFDocument interface instead
void	setXDC(String xdcName) Deprecated. Make use of IWDPDFDocument interface instead
void	setXsltURI(String url) Deprecated. Make use of IWDPDFDocument interface instead
InputStream	sign(String credential, String fieldName, String reason, String location, String contactInfo) Deprecated. Make use of IWDPDFDocument interface instead
void	suppressPrint(boolean suppress) Deprecated. Make use of IWDPDFDocument interface instead

Method Detail

getData

public InputStream getData()

Deprecated. Make use of IWDPDFDocument interface instead

Method getData returns the data from a PDF File Preconditions: method setPDF must have been called

Returns:

XFD

getData

public boolean getData(String url)

Deprecated. Make use of IWDPDFDocument interface instead

Method getData returns the data from a PDF File. The result is written to the given url. Method returns true when call was successful. Preconditions: method setPDF must have been called

Parameters:

url - destination where data is saved respectively to which data is posted

Returns:

createPDF

public boolean createPDF(String url)

Deprecated. Make use of IWDPDFDocument interface instead

Method createPDF creates a PDFDocument and the result is written to the given url. Method returns true when call was successful. Preconditions: setData and setTemplate must have been called

Parameters:

url -

Returns:

createPDF

public InputStream createPDF()

Deprecated. Make use of IWDPDFDocument interface instead

Method createPDF creates a PDFDocument and the result is returned as InputStream Preconditions: setData and setTemplate must have been called

Returns:

setData

public void setData(String url)

Deprecated. Make use of IWDPDFDocument interface instead

Method setData sets a URL pointing to the document containing the form data(XFD) that is used for creating the PDF

Parameters:

url -

setData

public void setData(OutputStream xfd)

Deprecated. Make use of IWDPDFDocument interface instead

Method setData sets an OutputStream that contains data that is used for creating the PDF.

setPDF

public void setPDF(String url)

Deprecated. Make use of IWDPDFDocument interface instead

Method setPDF sets the PDF document that should be examined i.e. from that data should be extracted, digital signatures should be verified

Parameters:

url -

setPDF

public void setPDF(ByteArrayOutputStream pdf)

Deprecated. Make use of IWDPDFDocument interface instead

Method setPDF sets the PDF document that should be examined i.e. from that data should be extracted, digital signatures should be verified

setLocale

public void setLocale(Locale locale)

Deprecated. Make use of IWDPDFDocument interface instead

Method setLocale can be called to set the locale for the PDF document. Required for decimal digits when the localized version of the template is not available

Parameters:

locale -

setSecurity

public void setSecurity(List certificates,
                        boolean printable,
                        boolean fillable,
                        boolean changeable,
                        boolean extractable)

Deprecated. Make use of IWDPDFDocument interface instead

Parameters:

certificates -

printable -

fillable -

changeable -

extractable -

setTemplate

public void setTemplate(String url)

Deprecated. Make use of IWDPDFDocument interface instead

Method setTemplate sets a URL that points to the Template used for creating the PDF.

Parameters:

url -

setTemplate

public void setTemplate(OutputStream template)

Deprecated. Make use of IWDPDFDocument interface instead

Method setTemplate sets an OutputStream that contains the Template used for creating the PDF.

setInteractive

public void setInteractive(boolean b)

Deprecated. Make use of IWDPDFDocument interface instead

Method setInteractive creates an interactive form

Parameters:

b -

setSecureCommunication

public void setSecureCommunication(boolean b)

Deprecated. Make use of IWDPDFDocument interface instead

Method setSecureCommunication. Default is not secure. Method will be removed and the security level will be defined by the concrete call requirements

Parameters:

b -

setBaseURI

public void setBaseURI(String url)

Deprecated. Make use of IWDPDFDocument interface instead

Method setBaseURI.

Parameters:

url -

setXsltURI

public void setXsltURI(String url)

Deprecated. Make use of IWDPDFDocument interface instead

Method setXsltURI can be used to set a XSLT that is applied to the data before it is returned.

Parameters:

url -

getColumnData

public boolean getColumnData(String url)

Deprecated. Make use of IWDPDFDocument interface instead

Method getColumnData.

Parameters:

url -

Returns:

getColumnData

public InputStream getColumnData()

Deprecated. Make use of IWDPDFDocument interface instead

Method getColumnData.

Returns:

getResultString

public String getResultString()

Deprecated. Make use of IWDPDFDocument interface instead

Method getResultString returns the return code of the last call

Returns:

setUsageRights

public void setUsageRights(String credential,
                           WDUsageRight[] rights)

Deprecated. Make use of IWDPDFDocument interface instead

Method setUsageRights allows to set usage rights. UsageRight are predefined e.g. "WDFormRights.ADD".

Parameters:

credential - if "null" default "ReaderRights" is used

rights -

setUserName

public void setUserName(String userName)

Deprecated. Make use of IWDPDFDocument interface instead

Method setUserName sets the user name that is used for applying rights or digital signatures.

Parameters:

userName -

getApplicationName

public String getApplicationName()

Deprecated. Make use of IWDPDFDocument interface instead

Get the application name within which the PDFObject is runnning.

setApplicationName

public void setApplicationName(String applicationName)

Deprecated. Make use of IWDPDFDocument interface instead

Set the application name within which the PDFObject is runnning.

getClientID

public String getClientID()

Deprecated. Make use of IWDPDFDocument interface instead

Get the Client ID who wants the PDFObject service.

setClientID

public void setClientID(String clientID)

Deprecated. Make use of IWDPDFDocument interface instead

Set the Client ID who wants the PDFObject service.

getFormName

public String getFormName()

Deprecated. Make use of IWDPDFDocument interface instead

Get the PDF form name for which the PDFObject is being processed.

setFormName

public void setFormName(String formName)

Deprecated. Make use of IWDPDFDocument interface instead

Set the PDF form name for which the PDFObject is being processed.

getReviewCopy

public boolean getReviewCopy(String url)

Deprecated. Make use of IWDPDFDocument interface instead

Method getReviewCopy gets the Review Copy from the ADS in a read only mode. Result will be written to the url specified. Preconditions : setPDF/setTemplate and setData should be called before calling this method.

Parameters:

url - : String

Returns:

boolean

getReviewCopy

public InputStream getReviewCopy()

Deprecated. Make use of IWDPDFDocument interface instead

Method getReviewCopy gets the Review Copy from the ADS in a read only mode. Result is returned as InputStream. Preconditions : setPDF/setTemplate and setData should be called before calling this method.

Returns:

InputStream : String

certify

public InputStream certify(String credential,
                           String fieldName,
                           String reason,
                           String location,
                           String contactInfo,
                           String legalAttestations,
                           String permissionMode)

Deprecated. Make use of IWDPDFDocument interface instead

Method certify puts a request to apply certificate on the pdf document under consideration. 1. Applying certificate while creating a new PDF. Following will be the method call sequence in this case: 1. setTemplate 2. setData 3. certify 4. createPDF A new PDF will be created and certified. A SOAP call will be made only at the call "createPDF". 2. Applying certificate on an existing PDF document. An existing PDF needs to be supplied in this case. Following will be the method call sequence in this scenario: 1. setPDF 2. certify Certificate will be applied to the document specified. A SOAP call will be made immediately at the call "certify". Make sure, that you have already set the PDF document (setPDF) before you call "certify". If the certificate needs to be applied on an existing PDF document, the method returns an InputStream carrying the PDF document else returns null.

Parameters:

credential - : Optional. Name of the private key. Default is "DocumentCertification".

reason - : Optional. If not set the default I attest to the accuracy and integrity of this document will be set.

location - : Optional. If not set the default will be empty.

Returns:

InputStream

getCertification

public boolean getCertification()

Deprecated. Make use of IWDPDFDocument interface instead

Method getCertification returns the status of the certificate for the pdf document under consideration. True if the certificate for the document is intact and false if it has been broken.

Returns:

boolean

suppressPrint

public void suppressPrint(boolean suppress)

Deprecated. Make use of IWDPDFDocument interface instead

Method suppressPrint.

Returns:

nil

createPDL

public boolean createPDL(String url)

Deprecated. Make use of IWDPDFDocument interface instead

Method createPDL creates a PDLDocument (PCL or PostScript document) and the result is written to the given url. Method returns true if the PDL creation is successful. Preconditions: setData, setTemplate, setXDC, setDestination must be called before a createPDL call.

Returns:

boolean

createPDL

public InputStream createPDL()

Deprecated. Make use of IWDPDFDocument interface instead

Method createPDL creates a PDLDocument (PCL or PostScript document) and the result is written back as an InputStream object. Preconditions: setData, setTemplate, setXDC, setDestination must be called before a createPDL call.

Returns:

InputStream : Input Stream of PDL document.

getPDL

public boolean getPDL(String url)

Deprecated. Make use of IWDPDFDocument interface instead

Method getPDL gets a PDLDocument (PCL or PostScript document) out of an existing PDF and the result is written to the given url. Method returns true if the PDL fetch is successful. Preconditions: 1. setPDF 2. setPDLType must be called. "PS2" and "PS3" are the currently supported types. Future support for "PCL5" is possible.

Returns:

boolean

See Also:

method.

getPDL

public InputStream getPDL()

Deprecated. Make use of IWDPDFDocument interface instead

Method getPDL creates a PDLDocument (PCL or PostScript document) out of an existing PDF document and the result is written back as an InputStream object. Preconditions: 1. setPDF 2. setPDLType must be called. "PS2" and "PS3" are the currently supported types. Future support for "PCL5" is possible.

Returns:

InputStream : Input Stream of PDL document.

See Also:

method.

setXDC

public void setXDC(String xdcName)

Deprecated. Make use of IWDPDFDocument interface instead

Method xdcName sets the name of the XDC to be used. Note that : 1. This method must be called before a createPDL call. 2. This method must not be called for any PDF based processing. Only meant for PDL based processing.

Parameters:

xdcName -

setDestination

public void setDestination(String destination)

Deprecated. Make use of IWDPDFDocument interface instead

Method setDestination sets the output destination before a createPDL call. The possible values are "ps" or "pcl", based on the possible printer configuration. Must be called before a createPDL call.

Parameters:

destination -

setPDLType

public void setPDLType(String pdlType)

Deprecated. Make use of IWDPDFDocument interface instead

Method setPDLType sets the type of PDL used. The possible values are "PS2", "PS3". Future support for PCL5 is possible. Must be set before a getPDL call.

Parameters:

pdlType -

setConfigURL

public void setConfigURL(String URL)

Deprecated. Make use of IWDPDFDocument interface instead

Method setConfigURL is used to set a custom configuration file (.xci file). The default is xfa.xci. Presently this configuration file should be available locally on the ADS. But this could be a URL as well. This option has been kept open for future provisions. Hence, specify the exact name of the configuration file as the parameter to the method and make sure with your ADS administrator that the file is available on the local ADS.

setDynamicPDF

public void setDynamicPDF(boolean dynamicPDF)

Deprecated. Make use of IWDPDFDocument interface instead

Method setDynamicPDF can be called to instruct ADS to create a dynamic PDF rather than a static PDF.

sign

public InputStream sign(String credential,
                        String fieldName,
                        String reason,
                        String location,
                        String contactInfo)

Deprecated. Make use of IWDPDFDocument interface instead

Method "sign" is used to apply a signature to an existing signature field on an Interactive Form. Applying a signature can happen in two ways: 1. Applying signature while creating a new PDF. So, following will be the method call sequence in this case: 1. setTemplate 2. setData 3. sign 4. createPDF A new PDF will be created and will be signed. A SOAP call will be made only at the call "createPDF". 2. Applying signature on an existing PDF document. An existing PDF needs to be supplied in this case. Following will be the method call sequence in this scenario: 1. setPDF 2. sign Digital Signature will be applied to the document specified. A SOAP call will be made immediately at the call "sign". Make sure, that you have already set the PDF document (setPDF) before you call "sign". If the signature needs to be applied on an existing PDF document, the method returns an InputStream carrying the PDF document else returns null.

Parameters:

credential - : Optional name of the private key to be used to sign the document. Default is "ServerSignature".

fieldName - : The name of the field on which to apply the certification. If this field is ommited ot is left empty, signature will be added to the document, but will not be shown in the document itself.

reason - : Optional. Default is "I attest to the accuracy and integrity of this document".

location - : Optional. Default is "".

Returns:

InputStream / null

changesNotAllowed

public void changesNotAllowed(boolean changesNotAllowed)

Deprecated. Make use of IWDPDFDocument interface instead

Method changesNotAllowed should be used to set the "changesNotAllowed" flag to true or false. When set to true, the document can not be changed. Requires a secure communication path to be established.

Parameters:

changesNotAllowed -