com.compoze.exchange.webdav
Class JournalEntry

java.lang.Object

  |

  +--com.compoze.exchange.webdav.AbstractItem

        |

        +--com.compoze.exchange.webdav.AbstractMessage

              |

              +--com.compoze.exchange.webdav.JournalEntry

All Implemented Interfaces:

java.lang.Cloneable, IItem, java.io.Serializable

public class JournalEntry

extends AbstractMessage

implements java.io.Serializable, java.lang.Cloneable

This class extends AbstractMessage to represent a message that is a journal entry in the Exchange store. Functionality may be very limited due to the lack of support by Microsoft for manipulating journal entries in Exchange Server via WebDAV.

The following table contains the properties defined in the Exchange store schema and mappings to their corresponding Java enumeration and methods:

Exchange Store Property	Property Enumeration	Java Methods
http://schemas.microsoft.com/mapi/companies	MapiProperty.COMPANIES	getCompanies() setCompanies(String[])
http://schemas.microsoft.com/mapi/id/{0006200A-0000-0000-C000-000000000046}/x00008700 http://schemas.microsoft.com/mapi/id/{0006200A-0000-0000-C000-000000000046}/x00008712	MapiProperty.JOURNAL_ENTRY MapiProperty.JOURNAL_ENTRY_TYPE	getEntryType() setEntryType(JournalEntryType)
http://schemas.microsoft.com/mapi/id/{0006200A-0000-0000-C000-000000000046}/x00008706	MapiProperty.JOURNAL_START_DATE	getStartDate() setStartDate(Date)
http://schemas.microsoft.com/mapi/id/{0006200A-0000-0000-C000-000000000046}/x00008707	MapiProperty.JOURNAL_DURATION	getDuration() setDuration(int)
http://schemas.microsoft.com/mapi/id/{0006200A-0000-0000-C000-000000000046}/x00008708	MapiProperty.JOURNAL_END_DATE	getEndDate() setEndDate(Date)
http://schemas.microsoft.com/mapi/proptag/x1000001f	MapiProperty.BODY_WIDE	getTextDescription() setTextDescription(String)

See Also:

Serialized Form

Constructor Summary

JournalEntry(java.lang.String sSubject, JournalEntryType type, java.util.Date startDate)
Constructor.

Method Summary

java.lang.Object	clone() Creates and returns a copy of this object.
java.util.LinkedList	getBccAddresses() Gets the blind carbon copy (Bcc) addresses.
java.lang.String	getBccAddressesString() Gets the string representation of a list of blind carbon copy (Bcc) addresses.
com.compoze.util.mail.InternetAddress[]	getBccRecipients() Gets internet addresses of recipients set in the "Bcc" (blind carbon copy) field.
java.util.LinkedList	getCcAddresses() Gets the carbon copy (Cc) addresses.
java.lang.String	getCcAddressesString() Gets the string representation of a list of carbon copy (Cc) addresses.
com.compoze.util.mail.InternetAddress[]	getCcRecipients() Gets internet addresses of recipients set in the "Cc" (carbon copy) field.
java.lang.String[]	getCompanies() Gets the companies associated with this journal entry.
static java.util.List	getDefaultProperties() Gets a list of default properties pertaining to an jouranl entry.
int	getDuration() Gets the duration (in minutes) for this journal entry.
java.util.Date	getEndDate() Gets the end date for this journal entry.
JournalEntryType	getEntryType() Gets the entry type for this journal entry.
com.compoze.util.mail.InternetAddress[]	getFrom() Gets internet addresses of whom this message was sent.
java.util.LinkedList	getFromAddresses() Gets the addresses from whom the message was sent.
java.lang.String	getFromAddressesString() Gets the string representation of a list of from whom the message was sent.
static java.util.List	getProperties() Gets a list of all properties pertaining to a journal entry.
java.util.Date	getStartDate() Gets the start date for this journal entry.
java.lang.String	getTextDescription() Gets the plain text version of the message.
java.util.LinkedList	getToAddresses() Gets the principal (To) addresses.
java.lang.String	getToAddressesString() Gets the string representation of a list of principal (To) addresses.
com.compoze.util.mail.InternetAddress[]	getToRecipients() Gets internet addresses of recipients set in the "To" (principal) field.
void	serverUpdate(boolean bServerRefresh) Requests the server to update the journal entry of any changed properties.
void	setBccAddresses(java.util.List addresses) Sets the blind carbon copy (Bcc) addresses.
void	setBccRecipients(com.compoze.util.mail.InternetAddress[] addressList) Sets "Bcc" (blind carbon copy) field with recipient's internet addresses.
void	setBccRecipients(java.lang.String sAddressList) Sets "Bcc" (blind carbon copy) field with sequence of recipient's internet addresses.
void	setCcAddresses(java.util.List addresses) Sets the carbon copy (Cc) addresses.
void	setCcRecipients(com.compoze.util.mail.InternetAddress[] addressesList) Sets "Cc" (carbon copy) field with recipient's internet addresses.
void	setCcRecipients(java.lang.String sAddressList) Sets "Cc" (carbon copy) field with sequence of recipient's internet addresses.
void	setCompanies(java.util.List companies) Sets the companies associated with this journal entry.
void	setCompanies(java.lang.String[] companies) Sets the companies associated with this journal entry.
void	setDuration(int iDuration) Sets the duration (in minutes) for this journal entry.
void	setEndDate(java.util.Date date) Sets the end date for this journal entry.
void	setEntryType(JournalEntryType type) Sets the entry type for this journal entry.
void	setFrom(com.compoze.util.mail.InternetAddress[] addressesList) Sets "From" field with internet addresses of whom this message was sent.
void	setFrom(java.lang.String sAddressList) Sets "From" field with sequence of internet addresses of whom this message was sent.
void	setFromAddress(java.lang.String sFromAddress) Sets the address from whom the message was sent.
void	setFromAddresses(java.util.List addresses) Sets the addresses from whom the message was sent.
void	setStartDate(java.util.Date date) Sets the start date for this journal entry.
void	setTextDescription(java.lang.String sTextDescription) Sets the plain text version of the message.
void	setToAddresses(java.util.List addresses) Sets the principal (To) addresses.
void	setToRecipients(com.compoze.util.mail.InternetAddress[] addressList) Sets "To" (principal) field with recipient's internet addresses.
void	setToRecipients(java.lang.String sAddressList) Sets "To" (principal) field with sequence of recipient's internet addresses.
java.lang.String	toString() Returns a string representation of the object.

Methods inherited from class com.compoze.exchange.webdav.AbstractMessage

addAttachment, createFilename, equals, getAttachments, getBody, getCategories, getContactNames, getDateReceived, getFromEmailAddress, getFromName, getImportance, getNormalizedSubject, getSensitivity, getSize, getSubject, getType, hasAttachment, isRead, serverDeleteAttachment, serverGetAttachments, setBody, setCategories, setCategories, setContactNames, setContactNames, setDateReceived, setImportance, setRead, setSensitivity, setSubject, setType

Methods inherited from class com.compoze.exchange.webdav.AbstractItem

copy, copy, copy, createFilename, delete, equals, getComment, getContentClass, getCreationDate, getDateLastModified, getDisplayName, getFile, getHRef, getID, getParentFolder, getPermanentURL, getUID, isFolder, isHidden, isReadOnly, isRoot, move, move, move, serverCopyTo, serverCopyTo, serverCopyTo, serverCopyTo, serverDelete, serverGetParentFolder, serverMoveTo, serverMoveTo, serverMoveTo, serverMoveTo, serverUpdate, setComment, setContentClass, setContentClass, setHidden, setReadOnly, setReleased, setType, setUID, update, update, validate

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

JournalEntry

public JournalEntry(java.lang.String sSubject,
                    JournalEntryType type,
                    java.util.Date startDate)

Constructor.

Parameters:

sSubject - the subject of the entry.

Method Detail

getTextDescription

public java.lang.String getTextDescription()

Gets the plain text version of the message.

Overrides:

getTextDescription in class AbstractMessage

Returns:

the plain text

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

MapiProperty.BODY_WIDE

setTextDescription

public void setTextDescription(java.lang.String sTextDescription)

Sets the plain text version of the message.

Overrides:

setTextDescription in class AbstractMessage

Parameters:

sTextDescription - the plain text

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

MapiProperty.BODY_WIDE

getEntryType

public JournalEntryType getEntryType()

Gets the entry type for this journal entry.

Returns:

the entry for the journal entry.

See Also:

MapiProperty.JOURNAL_ENTRY

setEntryType

public void setEntryType(JournalEntryType type)

Sets the entry type for this journal entry.

Parameters:

type - the entry type for the journal entry.

See Also:

MapiProperty.JOURNAL_ENTRY

getStartDate

public java.util.Date getStartDate()

Gets the start date for this journal entry.

Returns:

the start date for the journal entry.

See Also:

MapiProperty.JOURNAL_START_DATE

setStartDate

public void setStartDate(java.util.Date date)

Sets the start date for this journal entry.

Parameters:

date - the start date for the journal entry.

See Also:

MapiProperty.JOURNAL_START_DATE

getEndDate

public java.util.Date getEndDate()

Gets the end date for this journal entry.

Returns:

the end date for the journal entry.

See Also:

MapiProperty.JOURNAL_END_DATE

setEndDate

public void setEndDate(java.util.Date date)

Sets the end date for this journal entry.

Parameters:

date - the end date for the journal entry.

See Also:

MapiProperty.JOURNAL_END_DATE

getDuration

public int getDuration()

Gets the duration (in minutes) for this journal entry.

Returns:

the duration for the journal entry.

See Also:

MapiProperty.JOURNAL_DURATION

setDuration

public void setDuration(int iDuration)

Sets the duration (in minutes) for this journal entry.

Parameters:

date - the duration for the journal entry.

See Also:

MapiProperty.JOURNAL_DURATION

getCompanies

public java.lang.String[] getCompanies()

Gets the companies associated with this journal entry.

Returns:

list of companies associated with the journal entry.

See Also:

MapiProperty.COMPANIES

setCompanies

public void setCompanies(java.util.List companies)

Sets the companies associated with this journal entry.

Parameters:

companies - list of companies associated with the journal entry.

See Also:

MapiProperty.COMPANIES

setCompanies

public void setCompanies(java.lang.String[] companies)

Sets the companies associated with this journal entry.

Parameters:

companies - list of companies associated with the journal entry.

See Also:

MapiProperty.COMPANIES

getFromAddressesString

public java.lang.String getFromAddressesString()

Description copied from class: AbstractMessage

Gets the string representation of a list of from whom the message was sent.

Overrides:

getFromAddressesString in class AbstractMessage

Throws:

UnsupportedOperationException - if operation is not supported.

getFromAddresses

public java.util.LinkedList getFromAddresses()

Description copied from class: AbstractMessage

Gets the addresses from whom the message was sent.

Overrides:

getFromAddresses in class AbstractMessage

Throws:

UnsupportedOperationException - if operation is not supported.

setFromAddress

public void setFromAddress(java.lang.String sFromAddress)

Description copied from class: AbstractMessage

Sets the address from whom the message was sent.

Overrides:

setFromAddress in class AbstractMessage

Throws:

UnsupportedOperationException - if operation is not supported.

setFromAddresses

public void setFromAddresses(java.util.List addresses)

Description copied from class: AbstractMessage

Sets the addresses from whom the message was sent.

Overrides:

setFromAddresses in class AbstractMessage

Throws:

UnsupportedOperationException - if operation is not supported.

getFrom

public com.compoze.util.mail.InternetAddress[] getFrom()
                                                throws com.compoze.util.mail.AddressException

Gets internet addresses of whom this message was sent.

Overrides:

getFrom in class AbstractMessage

Returns:

array of InternetAddress objects; or null if not set

Throws:

com.compoze.util.mail.AddressException - if parsing of internet addresses fail

UnsupportedOperationException - if operation is not supported.

See Also:

MailHeaderProperty.FROM

setFrom

public void setFrom(java.lang.String sAddressList)
             throws com.compoze.util.mail.AddressException

Sets "From" field with sequence of internet addresses of whom this message was sent.

Overrides:

setFrom in class AbstractMessage

Parameters:

sAddressList - sequence of internet addresses

Throws:

com.compoze.util.mail.AddressException - if parsing of internet addresses fail

UnsupportedOperationException - if operation is not supported.

See Also:

MailHeaderProperty.FROM

setFrom

public void setFrom(com.compoze.util.mail.InternetAddress[] addressesList)

Sets "From" field with internet addresses of whom this message was sent.

Overrides:

setFrom in class AbstractMessage

Parameters:

addressesList - array of InternetAddress objects

Throws:

UnsupportedOperationException - if operation is not supported.

See Also:

MailHeaderProperty.FROM

getToAddressesString

public java.lang.String getToAddressesString()

Description copied from class: AbstractMessage

Gets the string representation of a list of principal (To) addresses.

Overrides:

getToAddressesString in class AbstractMessage

Throws:

UnsupportedOperationException - if operation is not supported.

getToAddresses

public java.util.LinkedList getToAddresses()

Description copied from class: AbstractMessage

Gets the principal (To) addresses.

Overrides:

getToAddresses in class AbstractMessage

Throws:

UnsupportedOperationException - if operation is not supported.

setToAddresses

public void setToAddresses(java.util.List addresses)

Description copied from class: AbstractMessage

Sets the principal (To) addresses.

Overrides:

setToAddresses in class AbstractMessage

Throws:

UnsupportedOperationException - if operation is not supported.

getToRecipients

public com.compoze.util.mail.InternetAddress[] getToRecipients()
                                                        throws com.compoze.util.mail.AddressException

Gets internet addresses of recipients set in the "To" (principal) field.

Overrides:

getToRecipients in class AbstractMessage

Returns:

array of InternetAddress objects; or null if not set

Throws:

com.compoze.util.mail.AddressException - if parsing of internet addresses fail

UnsupportedOperationException - if operation is not supported.

See Also:

MailHeaderProperty.TO

setToRecipients

public void setToRecipients(java.lang.String sAddressList)
                     throws com.compoze.util.mail.AddressException

Sets "To" (principal) field with sequence of recipient's internet addresses.

Overrides:

setToRecipients in class AbstractMessage

Parameters:

sAddressList - sequence of internet addresses

Throws:

com.compoze.util.mail.AddressException - if parsing of internet addresses fail

UnsupportedOperationException - if operation is not supported.

See Also:

MailHeaderProperty.TO

setToRecipients

public void setToRecipients(com.compoze.util.mail.InternetAddress[] addressList)

Sets "To" (principal) field with recipient's internet addresses.

Overrides:

setToRecipients in class AbstractMessage

Parameters:

addressList - array of InternetAddress objects

Throws:

UnsupportedOperationException - if operation is not supported.

See Also:

MailHeaderProperty.TO

getCcAddressesString

public java.lang.String getCcAddressesString()

Description copied from class: AbstractMessage

Gets the string representation of a list of carbon copy (Cc) addresses.

Overrides:

getCcAddressesString in class AbstractMessage

Throws:

UnsupportedOperationException - if operation is not supported.

getCcAddresses

public java.util.LinkedList getCcAddresses()

Description copied from class: AbstractMessage

Gets the carbon copy (Cc) addresses.

Overrides:

getCcAddresses in class AbstractMessage

Throws:

UnsupportedOperationException - if operation is not supported.

setCcAddresses

public void setCcAddresses(java.util.List addresses)

Description copied from class: AbstractMessage

Sets the carbon copy (Cc) addresses.

Overrides:

setCcAddresses in class AbstractMessage

Throws:

UnsupportedOperationException - if operation is not supported.

getCcRecipients

public com.compoze.util.mail.InternetAddress[] getCcRecipients()
                                                        throws com.compoze.util.mail.AddressException

Gets internet addresses of recipients set in the "Cc" (carbon copy) field.

Overrides:

getCcRecipients in class AbstractMessage

Returns:

array of InternetAddress objects; or null if not set

Throws:

com.compoze.util.mail.AddressException - if parsing of internet addresses fail

UnsupportedOperationException - if operation is not supported.

See Also:

MailHeaderProperty.CC

setCcRecipients

public void setCcRecipients(java.lang.String sAddressList)
                     throws com.compoze.util.mail.AddressException

Sets "Cc" (carbon copy) field with sequence of recipient's internet addresses.

Overrides:

setCcRecipients in class AbstractMessage

Parameters:

sAddressList - sequence of internet addresses

Throws:

com.compoze.util.mail.AddressException - if parsing of internet addresses fail

UnsupportedOperationException - if operation is not supported.

See Also:

MailHeaderProperty.CC

setCcRecipients

public void setCcRecipients(com.compoze.util.mail.InternetAddress[] addressesList)

Sets "Cc" (carbon copy) field with recipient's internet addresses.

Overrides:

setCcRecipients in class AbstractMessage

Parameters:

addressesList - array of InternetAddress objects

Throws:

UnsupportedOperationException - if operation is not supported.

See Also:

MailHeaderProperty.CC

getBccAddressesString

public java.lang.String getBccAddressesString()

Description copied from class: AbstractMessage

Gets the string representation of a list of blind carbon copy (Bcc) addresses.

Overrides:

getBccAddressesString in class AbstractMessage

Throws:

UnsupportedOperationException - if operation is not supported.

getBccAddresses

public java.util.LinkedList getBccAddresses()

Description copied from class: AbstractMessage

Gets the blind carbon copy (Bcc) addresses.

Overrides:

getBccAddresses in class AbstractMessage

Throws:

UnsupportedOperationException - if operation is not supported.

setBccAddresses

public void setBccAddresses(java.util.List addresses)

Description copied from class: AbstractMessage

Sets the blind carbon copy (Bcc) addresses.

Overrides:

setBccAddresses in class AbstractMessage

Throws:

UnsupportedOperationException - if operation is not supported.

getBccRecipients

public com.compoze.util.mail.InternetAddress[] getBccRecipients()
                                                         throws com.compoze.util.mail.AddressException

Gets internet addresses of recipients set in the "Bcc" (blind carbon copy) field.

Overrides:

getBccRecipients in class AbstractMessage

Returns:

array of InternetAddress objects; or null if not set

Throws:

com.compoze.util.mail.AddressException - if parsing of internet addresses fail

UnsupportedOperationException - if operation is not supported.

See Also:

MailHeaderProperty.BCC

setBccRecipients

public void setBccRecipients(java.lang.String sAddressList)
                      throws com.compoze.util.mail.AddressException

Sets "Bcc" (blind carbon copy) field with sequence of recipient's internet addresses.

Overrides:

setBccRecipients in class AbstractMessage

Parameters:

sAddressList - sequence of internet addresses

Throws:

com.compoze.util.mail.AddressException - if parsing of internet addresses fail

UnsupportedOperationException - if operation is not supported.

See Also:

MailHeaderProperty.BCC

setBccRecipients

public void setBccRecipients(com.compoze.util.mail.InternetAddress[] addressList)

Sets "Bcc" (blind carbon copy) field with recipient's internet addresses.

Overrides:

setBccRecipients in class AbstractMessage

Parameters:

addressList - array of InternetAddress objects

Throws:

UnsupportedOperationException - if operation is not supported.

See Also:

MailHeaderProperty.BCC

serverUpdate

public void serverUpdate(boolean bServerRefresh)
                  throws ExchangeException

Requests the server to update the journal entry of any changed properties.

If the journal entry does not exist in the Exchange store, it is created, else the existing journal entry is updated.

An AttachmentException is thrown if any conflicts occur attaching (uploading) files to the journal entry. The exception will state what files failed to attach. The journal entry is still updated and can be sent, but will exclude the failed attachments.

Overrides:

serverUpdate in class AbstractMessage

Parameters:

bServerRefresh - true requests the server to refresh the properties

Throws:

AttachmentException - if any files failed to attached to this journal entry.

ExchangeException - if a problem occurred while connecting to or interaction with Exchange Server

ExchangeRuntimeException - if this object has been released and can no longer be used

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Creates and returns a copy of this object.

Overrides:

clone in class AbstractMessage

Returns:

a clone of this instance.

Throws:

java.lang.CloneNotSupportedException - if the object's class does not support the Cloneable interface.

toString

public java.lang.String toString()

Returns a string representation of the object.

Overrides:

toString in class AbstractMessage

Returns:

the string representation of the object.

getDefaultProperties

public static java.util.List getDefaultProperties()

Gets a list of default properties pertaining to an jouranl entry.
Following is the list of properties returned:

• MapiProperty.JOURNAL_ENTRY
• MapiProperty.JOURNAL_ENTRY_TYPE
• MapiProperty.JOURNAL_END_DATE
• MapiProperty.JOURNAL_START_DATE
• MapiProperty.JOURNAL_DURATION
• MapiProperty.BODY_WIDE

Returns:

a list (unmodifiable) of properties.

See Also:

AbstractMessage.getDefaultProperties()

getProperties

public static java.util.List getProperties()

Gets a list of all properties pertaining to a journal entry.

Returns:

a list (unmodifiable) of properties.

See Also:

AbstractMessage.getProperties()