com.compoze.exchange.webdav
Class Task

java.lang.Object

  |

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

        |

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

              |

              +--com.compoze.exchange.webdav.Task

All Implemented Interfaces:

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

public class Task

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 tasks 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/exchange/mileage	ExchangeProperty.MILEAGE	getMileage() setMileage(String)
http://schemas.microsoft.com/mapi/companies	MapiProperty.COMPANIES	getCompanies() setCompanies(String[])
http://schemas.microsoft.com/mapi/billing	MapiProperty.BILLING	getBillingInformation() setBillingInformation(String)
http://schemas.microsoft.com/mapi/id/{00062003-0000-0000-C000-000000000046}/x00008101	MapiProperty.TASK_STATUS	getStatus() setStatus(TaskStatus)
http://schemas.microsoft.com/mapi/id/{00062003-0000-0000-C000-000000000046}/x00008102	MapiProperty.TASK_PERCENT_COMPLETE	getPercentComplete() setPercentComplete(double)
http://schemas.microsoft.com/mapi/id/{00062003-0000-0000-C000-000000000046}/x00008103	MapiProperty.TASK_TEAM_TASK	isTeamTask() setTeamTask(boolean)
http://schemas.microsoft.com/mapi/id/{00062003-0000-0000-C000-000000000046}/x00008104	MapiProperty.TASK_START_DATE	getStartDate() setStartDate(Date)
http://schemas.microsoft.com/mapi/id/{00062003-0000-0000-C000-000000000046}/x00008105	MapiProperty.TASK_DUE_DATE	getDueDate() setDueDate(Date)
http://schemas.microsoft.com/mapi/id/{00062003-0000-0000-C000-000000000046}/x0000810f	MapiProperty.TASK_DATE_COMPLETED	getDateCompleted() setDateCompleted(Date)
http://schemas.microsoft.com/mapi/id/{00062003-0000-0000-C000-000000000046}/x00008110	MapiProperty.TASK_ACTUAL_WORK	getActualWork() setActualWork(int)
http://schemas.microsoft.com/mapi/id/{00062003-0000-0000-C000-000000000046}/x00008111	MapiProperty.TASK_TOTAL_WORK	getTotalWork() setTotalWork(int)
http://schemas.microsoft.com/mapi/id/{00062003-0000-0000-C000-000000000046}/x0000811c	MapiProperty.TASK_COMPLETE	isComplete() setComplete(boolean)
http://schemas.microsoft.com/mapi/id/{00062003-0000-0000-C000-000000000046}/x0000811f	MapiProperty.TASK_OWNER	getOwner() setOwner(String)
http://schemas.microsoft.com/mapi/id/{00062003-0000-0000-C000-000000000046}/x00008126	MapiProperty.TASK_IS_RECURRING	isRecurring() setRecurring(boolean)
http://schemas.microsoft.com/mapi/id/{00062008-0000-0000-C000-000000000046}/x00008502	MapiProperty.REMINDER_TIME	getReminderTime() setReminderTime(Date)
http://schemas.microsoft.com/mapi/id/{00062008-0000-0000-C000-000000000046}/x00008503	MapiProperty.REMINDER_SET	isReminderSet() setReminderSet(boolean)
http://schemas.microsoft.com/mapi/id/{00062008-0000-0000-C000-000000000046}/x0000851C	MapiProperty.REMINDER_OVERRIDE	getReminderOverride() setReminderOverride(boolean)
http://schemas.microsoft.com/mapi/id/{00062008-0000-0000-C000-000000000046}/x0000851E	MapiProperty.REMINDER_PLAY_SOUND	getReminderPlaySound() setReminderPlaySound(boolean)
http://schemas.microsoft.com/mapi/id/{00062008-0000-0000-C000-000000000046}/x0000851F	MapiProperty.REMINDER_SOUND_FILE	getReminderSoundFile() setReminderSoundFile(String)
http://schemas.microsoft.com/mapi/proptag/x1000001f	MapiProperty.BODY_WIDE	getTextDescription() setTextDescription(String)

Below is an example of how to create a task:

  Task task = new Task("This task is for test purposes only", new Date());
  task.setBody("This task is for test purposes only.");
  task.setPercentComplete(0.25);
  task.setStatus(TaskStatus.IN_PROGRESS);
  task.setMileage("5 miles");
  task.setBillingInformation("Bill client");
  task.setCompanies(new String[] 
  	{
   	"Compoze Software"
   	});  
  task.setCategories(new String[] 
   	{
   	"Business",
	"Competition"
   	});

  taskFolder.addItem(task);
 

See Also:

Serialized Form

Constructor Summary

Task()
Constructor.

Task(java.lang.String sSubject)
Constructor.

Task(java.lang.String sSubject, java.util.Date dueDate)
Constructor.

Method Summary

java.lang.Object	clone() Creates and returns a copy of this object.
int	getActualWork() Gets the actual work (in minutes) for this task.
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.lang.String	getBillingInformation() Gets the billing information for this task.
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 task.
java.util.Date	getDateCompleted() Gets the completion date of this task.
static java.util.List	getDefaultProperties() Gets a list of default properties pertaining to a task.
java.util.Date	getDueDate() Gets the due date of this task.
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.
java.lang.String	getMileage() Gets the mileage for this task.
java.lang.String	getOwner() Gets the owner of this task.
double	getPercentComplete() Gets the percent completed of this task.
int	getPercentCompleteInt() Gets the percent complete property as an integer.
int	getPercentCompleteInt(boolean bBoundsException) Gets the percent complete property as an integer.
static java.util.List	getProperties() Gets a list of default properties pertaining to a task.
boolean	getReminderOverride() Determines whether or not the reminder for this task should be overriden.
boolean	getReminderPlaySound() Determines whether a sound should be played for the reminder of this task.
java.lang.String	getReminderSoundFile() Gets the sound file for the reminder of this task.
java.util.Date	getReminderTime() Gets the reminder time for this task.
java.util.Date	getStartDate() Gets the start date of this task.
TaskStatus	getStatus() Gets the status of this task.
java.lang.String	getTextDescription() Gets the plain text version of the distribution list.
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.
int	getTotalWork() Gets the total work (in minutes) for this task.
boolean	isComplete() Determines if this task is complete.
boolean	isRecurring() Determines if this task is recurring.
boolean	isReminderSet() Determines if the reminder is set for this task.
boolean	isTeamTask() Determines if this task is a team effort.
void	serverUpdate(boolean bServerRefresh) Requests the server to update the task of any changed properties.
void	setActualWork(int iActualWork) Sets the actual work (in minutes) for this task.
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	setBillingInformation(java.lang.String sBillingInformation) Sets the billing information for this task.
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 task.
void	setCompanies(java.lang.String[] companies) Sets the companies associated with this journal entry.
void	setComplete(boolean bComplete) Sets this task as complete.
void	setDateCompleted(java.util.Date dateCompleted) Sets the completion date of this task.
void	setDateCompleted(int iMonth, int iDay, int iYear) Sets the start date of the task.
void	setDueDate(java.util.Date dueDate) Sets the due date of this task.
void	setDueDate(int iMonth, int iDay, int iYear) Sets the start date of the task.
void	setMileage(java.lang.String sMileage) Sets the mileage for this task.
void	setOwner(java.lang.String sOwner) Sets the owner of this task.
void	setPercentComplete(double dPercentComplete) Sets the percent completed of this task.
void	setPercentComplete(int iPercentComplete) Sets the percent completed of this task.
void	setRecurring(boolean bRecurring) Sets this task as recurring.
void	setReminderOverride(boolean bOverride) Sets whether or not the reminder for this task should be overriden.
void	setReminderPlaySound(boolean bPlaySound) Sets whether a sound should be played for the reminder of this task.
void	setReminderSet(boolean bReminderSet) Sets the reminder as set for this task.
void	setReminderSoundFile(java.lang.String sFilename) Sets the sound file for the reminder of this task.
void	setReminderTime(java.util.Date reminderTime) Sets the reminder time for this task.
void	setStartDate(java.util.Date startDate) Sets the start date of this task.
void	setStartDate(int iMonth, int iDay, int iYear) Sets the start date of the task.
void	setStatus(TaskStatus status) Sets the the status of this task.
void	setTeamTask(boolean bTeamTask) Sets this task as a team effort.
void	setTextDescription(java.lang.String sTextDescription) Sets the plain text version of the distribution list.
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.
void	setTotalWork(int iTotalWork) Sets the total work (in minutes) for this task.
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, setFrom, setFrom, setFromAddress, setFromAddresses, 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

Task

public Task()

Constructor.

Task

public Task(java.lang.String sSubject)

Constructor.

Parameters:

sSubject - the subject of the task.

Task

public Task(java.lang.String sSubject,
            java.util.Date dueDate)

Constructor.

Parameters:

sSubject - the subject of the task.

dueDate - the due date of the task.

Method Detail

getTextDescription

public java.lang.String getTextDescription()

Gets the plain text version of the distribution list.

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 distribution list.

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

getReminderOverride

public boolean getReminderOverride()

Determines whether or not the reminder for this task should be overriden.

Returns:

true if the reminder for the task is overriden.

setReminderOverride

public void setReminderOverride(boolean bOverride)

Sets whether or not the reminder for this task should be overriden.

Parameters:

bOverride - true if the reminder for the task is overriden; false otherwise.

getReminderSoundFile

public java.lang.String getReminderSoundFile()

Gets the sound file for the reminder of this task.

Returns:

the sound file for the reminder of the task, or null if not set.

See Also:

MapiProperty.REMINDER_SOUND_FILE

setReminderSoundFile

public void setReminderSoundFile(java.lang.String sFilename)

Sets the sound file for the reminder of this task.

Parameters:

sFile - the sound file for the reminder of the task.

See Also:

MapiProperty.REMINDER_SOUND_FILE

getReminderPlaySound

public boolean getReminderPlaySound()

Determines whether a sound should be played for the reminder of this task.

Returns:

true if a sound should be played for the reminder of the task.

See Also:

MapiProperty.REMINDER_PLAY_SOUND

setReminderPlaySound

public void setReminderPlaySound(boolean bPlaySound)

Sets whether a sound should be played for the reminder of this task.

Returns:

true if a sound should be played for the reminder of the task; false otherwise.

See Also:

MapiProperty.REMINDER_PLAY_SOUND

isReminderSet

public boolean isReminderSet()

Determines if the reminder is set for this task.

Returns:

true if reminder is set for the task.

See Also:

MapiProperty.REMINDER_SET

setReminderSet

public void setReminderSet(boolean bReminderSet)

Sets the reminder as set for this task.

Parameters:

bReminderSet - true if reminder is set for the task; falsse otherwise.

See Also:

MapiProperty.REMINDER_SET

getReminderTime

public java.util.Date getReminderTime()

Gets the reminder time for this task.

Returns:

the reminder time for the task, or null if not set.

See Also:

MapiProperty.REMINDER_TIME

setReminderTime

public void setReminderTime(java.util.Date reminderTime)

Sets the reminder time for this task.

Parameters:

reminderTime - the reminder time for the task.

See Also:

MapiProperty.REMINDER_TIME

getCompanies

public java.lang.String[] getCompanies()

Gets the companies associated with this task.

Returns:

list of companies associated with the task.

See Also:

MapiProperty.COMPANIES

setCompanies

public void setCompanies(java.util.List companies)

Sets the companies associated with this task.

Parameters:

companies - list of companies associated with the task.

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

getMileage

public java.lang.String getMileage()

Gets the mileage for this task.

Returns:

the mileage for the task, or null if not set.

See Also:

ExchangeProperty.MILEAGE

setMileage

public void setMileage(java.lang.String sMileage)

Sets the mileage for this task.

Parameters:

sMileage - the mileage for the task.

See Also:

ExchangeProperty.MILEAGE

getBillingInformation

public java.lang.String getBillingInformation()

Gets the billing information for this task.

Returns:

the billing information for the task, or null if not set.

See Also:

MapiProperty.BILLING

setBillingInformation

public void setBillingInformation(java.lang.String sBillingInformation)

Sets the billing information for this task.

Returns:

the billing information for the task.

See Also:

MapiProperty.BILLING

isRecurring

public boolean isRecurring()

Determines if this task is recurring.

Returns:

true if the task is recurring.

See Also:

MapiProperty.TASK_IS_RECURRING

setRecurring

public void setRecurring(boolean bRecurring)

Sets this task as recurring.

Returns:

bRecurring true if the task is recurring; false otherwise.

See Also:

MapiProperty.TASK_IS_RECURRING

getOwner

public java.lang.String getOwner()

Gets the owner of this task.

Returns:

the owner of the task, or null if not set.

See Also:

MapiProperty.TASK_OWNER

setOwner

public void setOwner(java.lang.String sOwner)

Sets the owner of this task.

Parameters:

sOwner - the owner of the task.

See Also:

MapiProperty.TASK_OWNER

isComplete

public boolean isComplete()

Determines if this task is complete.

Returns:

true if the task is complete.

See Also:

MapiProperty.TASK_COMPLETE

setComplete

public void setComplete(boolean bComplete)

Sets this task as complete.
The following fields are updated in conjunction to calling this method:

• MapiProperty.TASK_STATUS
• MapiProperty.TASK_PERCENT_COMPLETE
• MapiProperty.TASK_DATE_COMPLETED

Returns:

bComplete true if the task is complete; false otherwise.

See Also:

MapiProperty.TASK_COMPLETE, setStatus(TaskStatus), setPercentComplete(double), setDateCompleted(Date)

getTotalWork

public int getTotalWork()

Gets the total work (in minutes) for this task.

Returns:

the total work (in minutes) for the task.

See Also:

MapiProperty.TASK_TOTAL_WORK

setTotalWork

public void setTotalWork(int iTotalWork)

Sets the total work (in minutes) for this task.

Parameters:

iTotalWork - the total work (in minutes) for the task.

See Also:

MapiProperty.TASK_TOTAL_WORK

getActualWork

public int getActualWork()

Gets the actual work (in minutes) for this task.

Returns:

the actual work (in minute) for the task.

See Also:

MapiProperty.TASK_ACTUAL_WORK

setActualWork

public void setActualWork(int iActualWork)

Sets the actual work (in minutes) for this task.

Parameters:

iAcutalWork - the actual work (in minute) for the task.

See Also:

MapiProperty.TASK_ACTUAL_WORK

getDateCompleted

public java.util.Date getDateCompleted()

Gets the completion date of this task.

Returns:

the completion date of the task, or null if not set.

See Also:

MapiProperty.TASK_DATE_COMPLETED

setDateCompleted

public void setDateCompleted(java.util.Date dateCompleted)

Sets the completion date of this task.
The following fields are updated in conjunction to calling this method:

• MapiProperty.TASK_STATUS
• MapiProperty.TASK_PERCENT_COMPLETE
• MapiProperty.TASK_COMPLETE

Returns:

the completion date of the task.

See Also:

MapiProperty.TASK_DATE_COMPLETED, setStatus(TaskStatus), setPercentComplete(double), setComplete(boolean)

setDateCompleted

public void setDateCompleted(int iMonth,
                             int iDay,
                             int iYear)
                      throws ExchangeException

Sets the start date of the task. The month, day and year are used to create a Date object whose time is 12AM GMT on the date that's specified, which is what Outlook expects.

Parameters:

iMonth - the month (1 == January)

iDay - the day of the month (first day of month is 1)

iYear - the year

getDueDate

public java.util.Date getDueDate()

Gets the due date of this task.

Returns:

the due date of the task, or null if not set.

See Also:

MapiProperty.TASK_DUE_DATE

setDueDate

public void setDueDate(java.util.Date dueDate)

Sets the due date of this task.

Returns:

the due date of the task.

See Also:

MapiProperty.TASK_DUE_DATE

setDueDate

public void setDueDate(int iMonth,
                       int iDay,
                       int iYear)
                throws ExchangeException

Sets the start date of the task. The month, day and year are used to create a Date object whose time is 12AM GMT on the date that's specified, which is what Outlook expects.

Parameters:

iMonth - the month (1 == January)

iDay - the day of the month (first day of month is 1)

iYear - the year

getStartDate

public java.util.Date getStartDate()

Gets the start date of this task.

Returns:

the start date of the task, or null if not set.

See Also:

MapiProperty.TASK_START_DATE

setStartDate

public void setStartDate(java.util.Date startDate)

Sets the start date of this task.

Returns:

the start date of the task.

See Also:

MapiProperty.TASK_START_DATE

setStartDate

public void setStartDate(int iMonth,
                         int iDay,
                         int iYear)
                  throws ExchangeException

Sets the start date of the task. The month, day and year are used to create a Date object whose time is 12AM GMT on the date that's specified, which is what Outlook expects.

Parameters:

iMonth - the month (1 == January)

iDay - the day of the month (first day of month is 1)

iYear - the year

isTeamTask

public boolean isTeamTask()

Determines if this task is a team effort.

Returns:

true if the task is a team effort.

See Also:

MapiProperty.TASK_TEAM_TASK

setTeamTask

public void setTeamTask(boolean bTeamTask)

Sets this task as a team effort.

Parameters:

bTeamTask - true if the task is a team effort; false otherwise.

See Also:

MapiProperty.TASK_TEAM_TASK

getPercentComplete

public double getPercentComplete()

Gets the percent completed of this task.

   100% = 1.000000e+000
   25% = 2.500000e-001
   10% = 1.000000e-001
   5% = 5.000000e-002
   2.5% = 2.500000e-002
 

Returns:

the percent complete of the task.

See Also:

MapiProperty.TASK_PERCENT_COMPLETE

getPercentCompleteInt

public int getPercentCompleteInt()

Gets the percent complete property as an integer. No exception is thrown if the value if less than 0 or greater than 100.

Returns:

the percent complete as an integer between 0 and 100 (values below 0 and above 100 are set to 0 and 100, respectively unless the bBoundsException parameter is set to true)

See Also:

getPercentComplete()

getPercentCompleteInt

public int getPercentCompleteInt(boolean bBoundsException)

Gets the percent complete property as an integer.

Parameters:

bBoundsException - if true, throw an exception if the value is less than 0 or greater than 100

Returns:

the percent complete as an integer between 0 and 100 (values below 0 and above 100 are set to 0 and 100, respectively unless the bBoundsException parameter is set to true)

See Also:

getPercentComplete()

setPercentComplete

public void setPercentComplete(double dPercentComplete)

Sets the percent completed of this task.

   100% = 1.000000e+000
   25% = 2.500000e-001
   10% = 1.000000e-001
   5% = 5.000000e-002
   2.5% = 2.500000e-002
 

The following fields are updated in conjunction to calling this method:

• MapiProperty.TASK_STATUS
• MapiProperty.TASK_DATE_COMPLETED
• MapiProperty.TASK_COMPLETE

Parameters:

the - percent complete of the task.

See Also:

MapiProperty.TASK_PERCENT_COMPLETE, setStatus(TaskStatus), setDateCompleted(Date), setComplete(boolean)

setPercentComplete

public void setPercentComplete(int iPercentComplete)

Sets the percent completed of this task.

Parameters:

iPercentComplete - the percentage of the task that is complete (must be between 0 and 100, inclusive)

See Also:

setPercentComplete(double)

getStatus

public TaskStatus getStatus()

Gets the status of this task.

Returns:

teh status of the task, or null if not set.

See Also:

MapiProperty.TASK_STATUS

setStatus

public void setStatus(TaskStatus status)

Sets the the status of this task.
The following fields are updated in conjunction to calling this method:

• MapiProperty.TASK_PERCENT_COMPLETE
• MapiProperty.TASK_DATE_COMPLETED
• MapiProperty.TASK_COMPLETE

Parameters:

status - the status of the task.

See Also:

MapiProperty.TASK_STATUS, setPercentComplete(double), setDateCompleted(Date), setComplete(boolean)

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.

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

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 task of any changed properties.

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

An AttachmentException is thrown if any conflicts occur attaching (uploading) files to the task. The exception will state what files failed to attach. The task 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 task.

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 a task.
Following is the list of properties returned:

• MapiProperty.TASK_STATUS
• MapiProperty.TASK_PERCENT_COMPLETE
• MapiProperty.TASK_DUE_DATE
• MapiProperty.TASK_DATE_COMPLETED
• MapiProperty.TASK_STATE
• MapiProperty.TASK_COMPLETE
• MapiProperty.BODY_WIDE

Returns:

a list (unmodifiable) of properties.

See Also:

AbstractMessage.getDefaultProperties()

getProperties

public static java.util.List getProperties()

Gets a list of default properties pertaining to a task.

Returns:

a list (unmodifiable) of properties.

See Also:

AbstractMessage.getProperties()