com.sap.tc.webdynpro.pdfobject.api
Interface IWDPDFObject

public interface IWDPDFObject

Interface IWDPDFObject describes the public interface of the PDFObject API.

Method Summary

void	certify(java.lang.String credential, java.lang.String fieldName, java.lang.String reason, java.lang.String location, java.lang.String contactInfo, java.lang.String legalAttestations, WDInteractiveFormPermissionModes permissionMode) Method certify puts a request to apply certificate on the pdf document under consideration.
java.io.InputStream	createPDF() Method createPDF creates a PDFDocument and the result is returned as InputStream Preconditions: setData and setTemplate must have been called
boolean	createPDF(java.lang.String url) Method createPDF creates a PDFDocument and the result is written to the given url.
java.lang.String	getApplicationName() Get the application name within which the PDFObject is runnning.
boolean	getCertification() Method getCertification returns the status of the certificate for the pdf document under consideration.
java.lang.String	getClientID() Get the Client ID who wants the PDFObject service.
java.io.InputStream	getColumnData() Method getColumnData.
boolean	getColumnData(java.lang.String url) Method getColumnData.
java.io.InputStream	getData() Method getData returns the data from a PDF File Preconditions: method setPDF must have been called
boolean	getData(java.lang.String url) Method getData returns the data from a PDF File.
java.lang.String	getFormName() Get the PDF form name for which the PDFObject is being processed.
java.lang.String	getResultString() Method getResultString returns the return code of the last call
java.io.InputStream	getReviewCopy() Method getReviewCopy gets the Review Copy from the ADS in a read only mode.
boolean	getReviewCopy(java.lang.String url) Method getReviewCopy gets the Review Copy from the ADS in a read only mode.
void	setApplicationName(java.lang.String applicationName) Set the application name within which the PDFObject is runnning.
void	setBaseURI(java.lang.String url) Method setBaseURI.
void	setClientID(java.lang.String clientID) Set the Client ID who wants the PDFObject service.
void	setData(java.io.OutputStream xfd) Method setData sets an OutputStream that contains data that is used for creating the PDF.
void	setData(java.lang.String url) Method setData sets a URL pointing to the document containing the form data(XFD) that is used for creating the PDF
void	setFormName(java.lang.String formName) Set the PDF form name for which the PDFObject is being processed.
void	setInteractive(boolean b) Method setInteractive creates an interactive form
void	setLocale(java.util.Locale locale) Method setLocale can be called to set the locale for the PDF document.
void	setPDF(java.io.ByteArrayOutputStream pdf) Method setPDF sets the PDF document that should be examined i.e.
void	setPDF(java.lang.String url) Method setPDF sets the PDF document that should be examined i.e.
void	setSecureCommunication(boolean b) Deprecated. This method may be withdrawn with the first new NetWeaver release in 2006.
void	setSecurity(java.util.List certificates, boolean printable, boolean fillable, boolean changeable, boolean extractable)
void	setTemplate(java.io.OutputStream template) Method setTemplate sets an OutputStream that contains the Template used for creating the PDF.
void	setTemplate(java.lang.String url) Method setTemplate sets a URL that points to the Template used for creating the PDF.
void	setUsageRights(java.lang.String credential, WDUsageRight[] rights) Method setUsageRights allows to set usage rights.
void	setUserName(java.lang.String userName) Method setUserName sets the user name that is used for applying rights or digital signatures.
void	setXsltURI(java.lang.String url) Method setXsltURI can be used to set a XSLT that is applied to the data before it is returned.
void	suppressPrint(boolean suppress) Method suppressPrint.

Method Detail

getData

public java.io.InputStream getData()

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

Returns:

XFD

getData

public boolean getData(java.lang.String url)

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(java.lang.String url)

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 java.io.InputStream createPDF()

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(java.lang.String url)

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(java.io.OutputStream xfd)

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

Parameters:

xfd. - If xfd is an ByteArrayOutputStream it must be UTF-8 encoded!

setPDF

public void setPDF(java.lang.String url)

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(java.io.ByteArrayOutputStream pdf)

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 -

setLocale

public void setLocale(java.util.Locale locale)

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(java.util.List certificates,
                        boolean printable,
                        boolean fillable,
                        boolean changeable,
                        boolean extractable)

setTemplate

public void setTemplate(java.lang.String url)

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

Parameters:

url -

setTemplate

public void setTemplate(java.io.OutputStream template)

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

Parameters:

template. - If template is an ByteArrayOutputStream it must be UTF-8 encoded!

setInteractive

public void setInteractive(boolean b)

Method setInteractive creates an interactive form

Parameters:

b -

setSecureCommunication

public void setSecureCommunication(boolean b)

Deprecated. This method may be withdrawn with the first new NetWeaver release in 2006.

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(java.lang.String url)

Method setBaseURI.

Parameters:

url -

setXsltURI

public void setXsltURI(java.lang.String url)

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(java.lang.String url)

Method getColumnData.

Parameters:

url -

Returns:

getColumnData

public java.io.InputStream getColumnData()

Method getColumnData.

Returns:

getResultString

public java.lang.String getResultString()

Method getResultString returns the return code of the last call

Returns:

setUsageRights

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

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(java.lang.String userName)

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

Parameters:

userName -

getApplicationName

public java.lang.String getApplicationName()

Get the application name within which the PDFObject is runnning.

setApplicationName

public void setApplicationName(java.lang.String applicationName)

Set the application name within which the PDFObject is runnning.

getClientID

public java.lang.String getClientID()

Get the Client ID who wants the PDFObject service.

setClientID

public void setClientID(java.lang.String clientID)

Set the Client ID who wants the PDFObject service.

getFormName

public java.lang.String getFormName()

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

setFormName

public void setFormName(java.lang.String formName)

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

getReviewCopy

public boolean getReviewCopy(java.lang.String url)

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 java.io.InputStream getReviewCopy()

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 void certify(java.lang.String credential,
                    java.lang.String fieldName,
                    java.lang.String reason,
                    java.lang.String location,
                    java.lang.String contactInfo,
                    java.lang.String legalAttestations,
                    WDInteractiveFormPermissionModes permissionMode)

Method certify puts a request to apply certificate on the pdf document under consideration.

Parameters:

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

field - name : Name of the filed to which certification will be applied. If this is not set then the certification will be added to the document itself, but will not be shown on the document itself. The user will see it as certified in a corner of the Acrobat UI.

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.

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

legal - attestations : Optional.

permission - mode : Optional. Mode of permission,allowing the user to change such as formFields or Comments, that won't break the certificate attached with the document. Currently available permission modes are :

None

FormFields

FormFieldsAndComments

Default permission mode is FormFields

Returns:

nil

getCertification

public boolean getCertification()

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)

Method suppressPrint.

Parameters:

boolean -

Returns:

nil