com.adobe.livecycle.pdfutility.client
Class RedactionResult

java.lang.Object
  com.adobe.livecycle.pdfutility.client.RedactionResult

All Implemented Interfaces:

java.io.Serializable

public class RedactionResult
extends java.lang.Object
implements java.io.Serializable

This class is used to store the redaction result including the resultant com.adobe.idp.Document.

See Also:

Serialized Form

Constructor Summary

RedactionResult()

Method Summary

Document	getDocument() Returns A com.adobe.idp.Document object which represents the redacted or annotated PDF document.
boolean	isRedactionSuccessful() Returns A boolean value representing whether or not the redaction was successful.
void	setDocument(Document document) Sets the document member object of the com.adobe.livecycle.pdfutility.client.RedactionResult object with the com.adobe.idp.Document parameter object provided.
void	setRedactionSuccessful(boolean redactionSuccessful) Sets the value of the boolean variable redactionSuccessful of this com.adobe.livecycle.pdfutility.client.RedactionResult object.

Methods inherited from class java.lang.Object

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

Constructor Detail

RedactionResult

public RedactionResult()

Method Detail

setDocument

public void setDocument(Document document)

Sets the document member object of the com.adobe.livecycle.pdfutility.client.RedactionResult object with the com.adobe.idp.Document parameter object provided.

Parameters:

document - A com.adobe.idp.Document object.

getDocument

public Document getDocument()

Returns A com.adobe.idp.Document object which represents the redacted or annotated PDF document.

Returns:

A com.adobe.idp.Document object which represents the redacted or annotated PDF document.

setRedactionSuccessful

public void setRedactionSuccessful(boolean redactionSuccessful)

Sets the value of the boolean variable redactionSuccessful of this com.adobe.livecycle.pdfutility.client.RedactionResult object. object with the boolean parameter provided which represents redaction success or failure.

Parameters:

redactionSuccessful - A boolean value specifying whether redaction was successful or not.

isRedactionSuccessful

public boolean isRedactionSuccessful()

Returns A boolean value representing whether or not the redaction was successful.

Returns:

The the value of the boolean variable redactionSuccessful representing whether or not the redaction was successful.