com.gnostice.documents

Class ConverterNeedPasswordEvent

java.lang.Object

java.util.EventObject

com.gnostice.documents.ConverterEvent

com.gnostice.documents.ConverterNeedPasswordEvent

All Implemented Interfaces:

Serializable

public class ConverterNeedPasswordEvent
extends ConverterEvent

This class represents an event when a user class instance implementing the ConverterListener needs a password to convert a document.

See Also:

ConverterListener.needPassword(ConverterNeedPasswordEvent), Serialized Form

Constructor Summary

Constructors

Constructor and Description
ConverterNeedPasswordEvent(Object source, Operation operation, ConverterJobInfoEvent jobInfo, ConverterInputDocumentInfoEvent inputDocumentInfo)

Method Summary

Modifier and Type	Method and Description
int	getAttemptCount() Returns number of attempts at providing a password has been made.
ConverterInputDocumentInfoEvent	getInputDocumentInfo() Returns details about the document.
Operation	getOperation() Returns current operation that is being performed on the document.
String	getPassword() Returns the current password to decrypt the document.
boolean	isCallAgainIfUnsuccessful() Returns whether the user-class instance is set to call this event if the specified password is not successful in decrypting the document.
boolean	isForceFullPermission() Returns whether document user permissions will be ignored when performing operations on the document.
void	setCallAgainIfUnsuccessful(boolean callAgainIfUnsuccessful) Specifies whether the user-class instance needs to call this event if the specified password is not successful in decrypting the document.
void	setForceFullPermission(boolean forceFullPermission) Specifies whether document user permissions should be ignored when performing operations on the document.
void	setPassword(String password) Specifies password with which the document needs to be decrypted.

Methods inherited from class com.gnostice.documents.ConverterEvent

getJobInfo, isCancel, setCancel

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ConverterNeedPasswordEvent

public ConverterNeedPasswordEvent(Object source,
                                  Operation operation,
                                  ConverterJobInfoEvent jobInfo,
                                  ConverterInputDocumentInfoEvent inputDocumentInfo)

Method Detail

setPassword

public void setPassword(String password)

Specifies password with which the document needs to be decrypted.

Parameters:

password - password for decrypting the document

getPassword

public String getPassword()

Returns the current password to decrypt the document.

Returns:

current password to decrypt the document

getOperation

public Operation getOperation()

Returns current operation that is being performed on the document.

Returns:

current document-processing operation

getAttemptCount

public int getAttemptCount()

Returns number of attempts at providing a password has been made.

Returns:

number of password attempts

isForceFullPermission

public boolean isForceFullPermission()

Returns whether document user permissions will be ignored when performing operations on the document.

Returns:

true if document user permissions will be ignore; false if otherwise

setForceFullPermission

public void setForceFullPermission(boolean forceFullPermission)

Specifies whether document user permissions should be ignored when performing operations on the document.

Parameters:

forceFullPermission - true if document user permissions should be ignored; false if otherwise

isCallAgainIfUnsuccessful

public boolean isCallAgainIfUnsuccessful()

Returns whether the user-class instance is set to call this event if the specified password is not successful in decrypting the document.

Returns:

true if the event is set to be called again; false if otherwise

setCallAgainIfUnsuccessful

public void setCallAgainIfUnsuccessful(boolean callAgainIfUnsuccessful)

Specifies whether the user-class instance needs to call this event if the specified password is not successful in decrypting the document.

Parameters:

callAgainIfUnsuccessful - true if the event needs to be called again; false if otherwise

getInputDocumentInfo

public ConverterInputDocumentInfoEvent getInputDocumentInfo()

Returns details about the document.

Returns:

details about the document