com.gnostice.documents

Class AddAttachmentEvent

java.lang.Object

java.util.EventObject

com.gnostice.documents.ConverterEvent

com.gnostice.documents.AddAttachmentEvent

All Implemented Interfaces:

Serializable

public class AddAttachmentEvent
extends ConverterEvent

This class represents an event when a user class instance implementing the ConverterListener adds a file to a document as an attachment.

See Also:

ConverterListener.addAttachment(AddAttachmentEvent), Serialized Form

Constructor Summary

Constructors

Constructor and Description
AddAttachmentEvent(Object source, ConverterJobInfoEvent jobInfo, String fileName, InputStream fileStream, boolean isStreamInput, boolean isExistingAttachment, String attachmentDescription, Date fileModifiedDate)

Method Summary

Modifier and Type	Method and Description
String	getAttachmentDescription() Returns text describing the attachment.
Date	getAttachmentFileModifiedDate() Returns last modified date of the attachment file.
String	getAttachmentFileName() Returns the name of the file name.
InputStream	getFileStream() Returns a stream containing the attachment.
boolean	isExistingAttachment() Specifies whether the attachment already exists in the document or is being added to document.
boolean	isSkipAttachment() Returns whether the current attachment should not processed.
boolean	isStreamInput() Specifies whether the attachment is created using a stream or file.
void	setAttachmentDescription(String attachmentDescription) Specifies text describing the attachment.
void	setAttachmentFileModifiedDate(Date attachmentFileModifiedDate) Specifies last modified date of the attachment file.
void	setAttachmentFileName(String fileName) Specifies the name of the attachment in the document.
void	setSkipAttachment(boolean skipAttachment) Specifies whether the current attachment should not processed.

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

AddAttachmentEvent

public AddAttachmentEvent(Object source,
                          ConverterJobInfoEvent jobInfo,
                          String fileName,
                          InputStream fileStream,
                          boolean isStreamInput,
                          boolean isExistingAttachment,
                          String attachmentDescription,
                          Date fileModifiedDate)

Method Detail

getAttachmentFileName

public String getAttachmentFileName()

Returns the name of the file name.

Returns:

name of the file name

setAttachmentFileName

public void setAttachmentFileName(String fileName)

Specifies the name of the attachment in the document.

Parameters:

fileName - name of the attachment in the document

getFileStream

public InputStream getFileStream()

Returns a stream containing the attachment.

Returns:

a stream containing the attachment

isStreamInput

public boolean isStreamInput()

Specifies whether the attachment is created using a stream or file.

Returns:

true if the attachment is created using a stream; false if otherwise.

isExistingAttachment

public boolean isExistingAttachment()

Specifies whether the attachment already exists in the document or is being added to document.

Returns:

true if the attachemnt already exists in document; false if otherwise

getAttachmentDescription

public String getAttachmentDescription()

Returns text describing the attachment.

Returns:

text describing the attachment

setAttachmentDescription

public void setAttachmentDescription(String attachmentDescription)

Specifies text describing the attachment.

Parameters:

attachmentDescription - text describing the attachment

getAttachmentFileModifiedDate

public Date getAttachmentFileModifiedDate()

Returns last modified date of the attachment file.

Returns:

last modified date of the attachment file

setAttachmentFileModifiedDate

public void setAttachmentFileModifiedDate(Date attachmentFileModifiedDate)

Specifies last modified date of the attachment file.

Parameters:

attachmentFileModifiedDate - last modified date of the attachment file

isSkipAttachment

public boolean isSkipAttachment()

Returns whether the current attachment should not processed.

Returns:

true if the attachment should be ignored; false if otherwise

setSkipAttachment

public void setSkipAttachment(boolean skipAttachment)

Specifies whether the current attachment should not processed.

Parameters:

skipAttachment - true if the attachment is set to be ignored; false if otherwise