|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface PDFUtilityService
Enables the creation of a Java object that invokes operations that belong to the PDF Utility service. Using this object, you can perform tasks such as converting a PDF document to an XDP file. Another task that you can perform is to query information about a PDF document. For example, you can determine whether a PDF document contains comments or attachments. For information, see Working With PDF Utility Service.
Method Summary | |
---|---|
Document |
clone(Document inPDFDoc)
Clones a PDF document. |
Document |
convertPDFtoXDP(Document inDoc)
Converts a PDF document into an XDP file. |
Document |
convertXDPtoPDF(Document inDoc)
Converts an XDP file into a PDF file. |
PDFPropertiesResult |
getPDFProperties(Document inPDFDoc,
PDFPropertiesOptionSpec options)
Performs queries on the specified PDF document and returns the results as a PDFPropertiesResponse object. |
PDFUtilitySaveMode |
getSaveMode(Document inPDFDoc)
Returns the save mode of a PDF document. |
java.lang.String |
getVersion()
Returns the PDF Utility service version. |
java.util.List |
multiclone(Document inPDFDoc,
int copies)
Clones a PDF document a specified number of times. |
RedactionResult |
redact(Document inDoc,
RedactionOptionSpec redactionOptionSpec)
Redacts an annotated PDF document. |
SanitizationResult |
sanitize(Document inDoc)
Sanitizes a pdf document by removing any unintended hidden information. |
Document |
setSaveMode(Document inPDFDoc,
PDFUtilitySaveMode saveMode,
boolean override)
Sets the save mode of a PDF document. |
Method Detail |
---|
java.lang.String getVersion()
PDFPropertiesResult getPDFProperties(Document inPDFDoc, PDFPropertiesOptionSpec options) throws PDFUtilityException
PDFPropertiesResponse
object.
inPDFDoc
- A Document
object that represents the PDF document on which to
perform the query.options
- A PDFUtilityOptionSpec
object that specifies which queries are performed.
PDFPropertiesResponse
object that contains the result of the query.
PDFUtilityException
- If an error occurs during this operation.Document convertXDPtoPDF(Document inDoc) throws PDFUtilityException
inDoc
- A Document
object that represents the XDP file to convert to a PDF file.
Document
object that represents the PDF document that was converted.
PDFUtilityException
- If an error occured during this operation. For example, if you specified an XDP
file that does not contain an embedded PDF data stream.Document convertPDFtoXDP(Document inDoc) throws PDFUtilityException
inDoc
- A Document
object that represents the PDF document to convert to an XDP
file.
Document
object that represents an XDP file.
PDFUtilityException
- If an error occured during this operation. For example, if you specified an XDP
file that does not contain an XFA stream.Document clone(Document inPDFDoc) throws PDFUtilityException
For example, assume that a PDF document is passed to two services sequentially.
When the first service modifies and returns the PDF document as a Document
object,
the next service to use the Document
object sees modifications
made by the first service.
After invoking the clone
method, you are assured that the input
Document
object
and the result Document
object are the same,
and that any future modification of either object will not be reflected in the other object.
inPDFDoc
- A Document
object that represents the PDF document to clone.
Document
object that represents the cloned PDF document.
PDFUtilityException
- If the document could not be cloned.java.util.List multiclone(Document inPDFDoc, int copies) throws PDFUtilityException
For example, assume that a PDF document is passed to two services sequentially.
When the first service modifies and returns the PDF document as a Document
object,
the next service to use the Document
object sees modifications
made by the first service.
After invoking the multiclone
method, you are assured that the input
Document
object
and the result Document
object contains the same content,
and that any future modification of either object will not be reflected in the other object.
inPDFDoc
- A Document
object that represents the PDF document to clone.copies
- The number of copies to return.
Document
objects that stores one or more cloned PDF documents.
PDFUtilityException
- If an error occurred while cloning the PDF document.PDFUtilitySaveMode getSaveMode(Document inPDFDoc)
The following are PDF save mode values:
FAST_WEB_VIEW
- Used while viewing the PDF document online.INCREMENTAL
- Performs the save operation in the least amount of time.FULL
- Saves with fewer optimizations.In addition, the save mode specifies whether the request is considered a requirement or only a suggestion. Save modes values are not influenced by the PDF document content.
inPDFDoc
- A Document
object that represents the PDF document for which save
mode information is returned.
PDFUtilitySaveMode
object that represents the save mode of the PDF document.PDFUtilityService.setSaveMode(Document,PDFUtilitySaveMode,boolean)
Document setSaveMode(Document inPDFDoc, PDFUtilitySaveMode saveMode, boolean override)
The following are PDF save mode values:
FAST_WEB_VIEW
- Used while viewing the PDF document online.INCREMENTAL
- Performs the save operation in the least amount of time.FULL
- Saves with fewer optimizations.
inPDFDoc
- A Document
object that represents the PDF document for
which save mode information is set.saveMode
- A PDFUtilitySaveMode
object that specifies the save mode of the PDF document.override
- A Boolean value that specifies whether to make the setting regardless of any previous requests.
Document
object that represents the PDF document for which the save
mode information has been set.PDFUtilityService.getSaveMode(Document)
RedactionResult redact(Document inDoc, RedactionOptionSpec redactionOptionSpec) throws PDFUtilityException
inDoc
- A com.adobe.idp.Document
object that represents the
input PDF document to be redacted.redactionOptionSpec
- A RedactionOptionSpec object which represents the default options
for the redaction process. These options shall apply by default to all those redaction regions whose
redaction options have not been specified explicitly.
RedactionResult
object.
PDFUtilityException
SanitizationResult sanitize(Document inDoc) throws PDFUtilityException
inDoc
- A com.adobe.idp.Document
object that represents the
input PDF document to be sanitized.
com.adobe.livecycle.pdfutility.client.SanitizationResult
object.
PDFUtilityException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |