com.moyosoft.connector.ms.outlook.appointment
Class OutlookAppointment

java.lang.Object
  |
  +--com.moyosoft.connector.ms.outlook.item.OutlookItem
        |
        +--com.moyosoft.connector.ms.outlook.appointment.OutlookAppointment
All Implemented Interfaces:
IAttachmentsContainer

public class OutlookAppointment
extends OutlookItem
implements IAttachmentsContainer

Represents an appointment or meeting item stored in the Outlook calendar.

A new appointment can be created by instantiating this class. To save the new appointment to the calendar, call the method save().

This class provides getter and setter methods to access or modify the appointment's properties.

See Also:
OutlookAppointment(Outlook), OutlookItem.save()

Constructor Summary
OutlookAppointment(com.moyosoft.connector.com.Dispatch dispatch)
           
OutlookAppointment(Outlook outlookApplication)
          Creates a new appointment item in the default calendar folder
OutlookAppointment(OutlookFolder folder)
          Creates a new appointment in the specified folder
 
Method Summary
 void clearRecurrencePattern()
           
 void close(InspectorClose saveMode)
           
 OutlookAttachment createAttachment(java.io.File pAttachmentFile, AttachmentType pType)
           
 OutlookMail forwardAsVcal()
           
 AttachmentsCollection getAttachments()
           
 int getAttachmentsCount()
           
 java.lang.String getBillingInformation()
           
 java.lang.String getBody()
           
 BusyStatus getBusyStatus()
           
 java.lang.String getCategories()
           
 int getColorLabel()
           
 java.lang.String getCompanies()
           
 java.lang.String getConferenceServerPassword()
           
 ConflictsCollection getConflicts()
           
 java.lang.String getConversationIndex()
           
 java.lang.String getConversationTopic()
           
 DownloadState getDownloadState()
           
 int getDuration()
           
 java.util.Date getEnd()
           
 FormDescription getFormDescription()
           
 java.lang.String getGlobalAppointmentId()
           
 ImportanceType getImportance()
           
 Inspector getInspector()
           
 int getInternetCodepage()
          The 'InternetCodepage' property is only supported by Outlook 2002 or higher.
 boolean getIsRecurring()
          Deprecated. Use the isRecurring() method instead.
 ItemPropertiesCollection getItemProperties()
           
 java.lang.String getLocation()
           
 RemoteStatus getMarkForDownload()
           
 MeetingStatus getMeetingStatus()
           
 java.lang.String getMeetingWorkspaceURL()
          The 'MeetingWorkspaceURL' property is only supported by Outlook 2003 or higher.
 java.lang.String getMessageClass()
           
 java.lang.String getMileage()
           
 java.lang.String getNetMeetingDocPathName()
           
 java.lang.String getNetMeetingOrganizerAlias()
           
 java.lang.String getNetMeetingServer()
           
 NetMeetingType getNetMeetingType()
           
 java.lang.String getNetShowURL()
           
 java.lang.String getOptionalAttendees()
           
 java.lang.String getOrganizer()
           
 RecipientsCollection getRecipients()
           
 RecurrencePattern getRecurrencePattern()
           
 RecurrenceState getRecurrenceState()
           
 int getReminderMinutesBeforeStart()
           
 java.lang.String getReminderSoundFile()
           
 java.util.Date getReplyTime()
           
 java.lang.String getRequiredAttendees()
           
 java.lang.String getResources()
           
 ResponseStatus getResponseStatus()
           
 Account getSendUsingAccount()
          Returns the account used when sending this message.
 SensitivityType getSensitivity()
           
 int getSize()
           
 java.util.Date getStart()
           
 java.lang.String getSubject()
           
 OutlookItemType getType()
           
 UserPropertiesCollection getUserProperties()
           
 boolean isAllDayEvent()
           
 boolean isAutoResolvedWinner()
           
 boolean isConferenceServerAllowExternal()
           
 boolean isConflict()
           
 boolean isNetMeetingAutoStart()
           
 boolean isNoAging()
           
 boolean isOnlineMeeting()
           
 boolean isRecurring()
           
 boolean isReminderOverrideDefault()
           
 boolean isReminderPlaySound()
           
 boolean isReminderSet()
           
 boolean isResponseRequested()
           
 boolean isSaved()
           
 boolean isUnRead()
           
 OutlookMeeting respond(MeetingResponse response)
           
 OutlookMeeting respond(MeetingResponse response, boolean dontDisplayDialogBox)
           
 OutlookMeeting respond(MeetingResponse response, boolean dontDisplayDialogBox, boolean promptUser)
           
 void send()
           
 void setAllDayEvent(boolean value)
           
 void setBillingInformation(java.lang.String value)
           
 void setBody(java.lang.String value)
           
 void setBusyStatus(BusyStatus value)
           
 void setCategories(java.lang.String value)
           
 void setColorLabel(int value)
           
 void setCompanies(java.lang.String value)
           
 void setConferenceServerAllowExternal(boolean value)
           
 void setConferenceServerPassword(java.lang.String value)
           
 void setDuration(int value)
           
 void setEnd(java.util.Date value)
           
 void setImportance(ImportanceType value)
           
 void setInternetCodepage(int value)
          The 'InternetCodepage' property is only supported by Outlook 2002 or higher.
 void setIsOnlineMeeting(boolean value)
           
 void setLocation(java.lang.String value)
           
 void setMarkForDownload(RemoteStatus value)
           
 void setMeetingStatus(MeetingStatus value)
           
 void setMessageClass(java.lang.String value)
           
 void setMileage(java.lang.String value)
           
 void setNetMeetingAutoStart(boolean value)
           
 void setNetMeetingDocPathName(java.lang.String value)
           
 void setNetMeetingOrganizerAlias(java.lang.String value)
           
 void setNetMeetingServer(java.lang.String value)
           
 void setNetMeetingType(NetMeetingType value)
           
 void setNetShowURL(java.lang.String value)
           
 void setNoAging(boolean value)
           
 void setOptionalAttendees(java.lang.String value)
           
 void setReminderMinutesBeforeStart(int value)
           
 void setReminderOverrideDefault(boolean value)
           
 void setReminderPlaySound(boolean value)
           
 void setReminderSet(boolean value)
           
 void setReminderSoundFile(java.lang.String value)
           
 void setReplyTime(java.util.Date value)
           
 void setRequiredAttendees(java.lang.String value)
           
 void setResources(java.lang.String value)
           
 void setResponseRequested(boolean value)
           
 void setSendUsingAccount(Account account)
          Define the account to be used when sending this message.
 void setSensitivity(SensitivityType value)
           
 void setStart(java.util.Date value)
           
 void setSubject(java.lang.String value)
           
 void setUnRead(boolean value)
           
 void showCategoriesDialog()
           
 
Methods inherited from class com.moyosoft.connector.ms.outlook.item.OutlookItem
copy, create, delete, deleteMapiProperty, deleteMapiProperty, display, display, dispose, equals, getCreationTime, getDispatch, getEntryId, getItemId, getLastModificationTime, getLinks, getMapiProperty, getMapiProperty, getParentFolder, getPropertyAccessor, move, printOut, save, saveAs, saveAs, saveAs, saveAs, setMapiProperty, setMapiProperty
 
Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

OutlookAppointment

public OutlookAppointment(OutlookFolder folder)
                   throws com.moyosoft.connector.com.ComponentObjectModelException
Creates a new appointment in the specified folder

Parameters:
folder - the folder where the new appointment will be created
Throws:
com.moyosoft.connector.com.ComponentObjectModelException - if a COM error occurs.

OutlookAppointment

public OutlookAppointment(Outlook outlookApplication)
                   throws com.moyosoft.connector.com.ComponentObjectModelException
Creates a new appointment item in the default calendar folder

Parameters:
outlookApplication - the Outlook application's object
Throws:
com.moyosoft.connector.com.ComponentObjectModelException - if a COM error occurs.

OutlookAppointment

public OutlookAppointment(com.moyosoft.connector.com.Dispatch dispatch)
Method Detail

getType

public OutlookItemType getType()
Specified by:
getType in class OutlookItem

getGlobalAppointmentId

public java.lang.String getGlobalAppointmentId()
                                        throws com.moyosoft.connector.com.ComponentObjectModelException
com.moyosoft.connector.com.ComponentObjectModelException

getColorLabel

public int getColorLabel()
                  throws com.moyosoft.connector.com.ComponentObjectModelException
com.moyosoft.connector.com.ComponentObjectModelException

setColorLabel

public void setColorLabel(int value)
                   throws com.moyosoft.connector.com.ComponentObjectModelException
com.moyosoft.connector.com.ComponentObjectModelException

getAttachments

public AttachmentsCollection getAttachments()
Specified by:
getAttachments in interface IAttachmentsContainer

createAttachment

public OutlookAttachment createAttachment(java.io.File pAttachmentFile,
                                          AttachmentType pType)
Specified by:
createAttachment in interface IAttachmentsContainer

getAttachmentsCount

public int getAttachmentsCount()
Specified by:
getAttachmentsCount in interface IAttachmentsContainer

getBillingInformation

public java.lang.String getBillingInformation()

setBillingInformation

public void setBillingInformation(java.lang.String value)

getBody

public java.lang.String getBody()

setBody

public void setBody(java.lang.String value)

getCategories

public java.lang.String getCategories()

setCategories

public void setCategories(java.lang.String value)

getCompanies

public java.lang.String getCompanies()

setCompanies

public void setCompanies(java.lang.String value)

getConversationIndex

public java.lang.String getConversationIndex()

getConversationTopic

public java.lang.String getConversationTopic()

getFormDescription

public FormDescription getFormDescription()

getInspector

public Inspector getInspector()

getImportance

public ImportanceType getImportance()

setImportance

public void setImportance(ImportanceType value)

getMessageClass

public java.lang.String getMessageClass()

setMessageClass

public void setMessageClass(java.lang.String value)

getMileage

public java.lang.String getMileage()

setMileage

public void setMileage(java.lang.String value)

isNoAging

public boolean isNoAging()

setNoAging

public void setNoAging(boolean value)

isSaved

public boolean isSaved()

getSensitivity

public SensitivityType getSensitivity()

setSensitivity

public void setSensitivity(SensitivityType value)

getSize

public int getSize()

getSubject

public java.lang.String getSubject()

setSubject

public void setSubject(java.lang.String value)

isUnRead

public boolean isUnRead()

setUnRead

public void setUnRead(boolean value)

getUserProperties

public UserPropertiesCollection getUserProperties()

close

public void close(InspectorClose saveMode)

isAllDayEvent

public boolean isAllDayEvent()

setAllDayEvent

public void setAllDayEvent(boolean value)

getBusyStatus

public BusyStatus getBusyStatus()

setBusyStatus

public void setBusyStatus(BusyStatus value)

getDuration

public int getDuration()

setDuration

public void setDuration(int value)

getEnd

public java.util.Date getEnd()

setEnd

public void setEnd(java.util.Date value)

isOnlineMeeting

public boolean isOnlineMeeting()

setIsOnlineMeeting

public void setIsOnlineMeeting(boolean value)

getIsRecurring

public boolean getIsRecurring()
Deprecated. Use the isRecurring() method instead.


isRecurring

public boolean isRecurring()

getLocation

public java.lang.String getLocation()

setLocation

public void setLocation(java.lang.String value)

getMeetingStatus

public MeetingStatus getMeetingStatus()

setMeetingStatus

public void setMeetingStatus(MeetingStatus value)

isNetMeetingAutoStart

public boolean isNetMeetingAutoStart()

setNetMeetingAutoStart

public void setNetMeetingAutoStart(boolean value)

getNetMeetingOrganizerAlias

public java.lang.String getNetMeetingOrganizerAlias()

setNetMeetingOrganizerAlias

public void setNetMeetingOrganizerAlias(java.lang.String value)

getNetMeetingServer

public java.lang.String getNetMeetingServer()

setNetMeetingServer

public void setNetMeetingServer(java.lang.String value)

getNetMeetingType

public NetMeetingType getNetMeetingType()

setNetMeetingType

public void setNetMeetingType(NetMeetingType value)

getOptionalAttendees

public java.lang.String getOptionalAttendees()

setOptionalAttendees

public void setOptionalAttendees(java.lang.String value)

getOrganizer

public java.lang.String getOrganizer()

getRecipients

public RecipientsCollection getRecipients()

getRecurrenceState

public RecurrenceState getRecurrenceState()

getReminderMinutesBeforeStart

public int getReminderMinutesBeforeStart()

setReminderMinutesBeforeStart

public void setReminderMinutesBeforeStart(int value)

isReminderOverrideDefault

public boolean isReminderOverrideDefault()

setReminderOverrideDefault

public void setReminderOverrideDefault(boolean value)

isReminderPlaySound

public boolean isReminderPlaySound()

setReminderPlaySound

public void setReminderPlaySound(boolean value)

isReminderSet

public boolean isReminderSet()

setReminderSet

public void setReminderSet(boolean value)

getReminderSoundFile

public java.lang.String getReminderSoundFile()

setReminderSoundFile

public void setReminderSoundFile(java.lang.String value)

getReplyTime

public java.util.Date getReplyTime()

setReplyTime

public void setReplyTime(java.util.Date value)

getRequiredAttendees

public java.lang.String getRequiredAttendees()

setRequiredAttendees

public void setRequiredAttendees(java.lang.String value)

getResources

public java.lang.String getResources()

setResources

public void setResources(java.lang.String value)

isResponseRequested

public boolean isResponseRequested()

setResponseRequested

public void setResponseRequested(boolean value)

getResponseStatus

public ResponseStatus getResponseStatus()

getStart

public java.util.Date getStart()

setStart

public void setStart(java.util.Date value)

clearRecurrencePattern

public void clearRecurrencePattern()

forwardAsVcal

public OutlookMail forwardAsVcal()

getRecurrencePattern

public RecurrencePattern getRecurrencePattern()

respond

public OutlookMeeting respond(MeetingResponse response)

respond

public OutlookMeeting respond(MeetingResponse response,
                              boolean dontDisplayDialogBox)

respond

public OutlookMeeting respond(MeetingResponse response,
                              boolean dontDisplayDialogBox,
                              boolean promptUser)

send

public void send()

getNetMeetingDocPathName

public java.lang.String getNetMeetingDocPathName()

setNetMeetingDocPathName

public void setNetMeetingDocPathName(java.lang.String value)

getNetShowURL

public java.lang.String getNetShowURL()

setNetShowURL

public void setNetShowURL(java.lang.String value)

isConferenceServerAllowExternal

public boolean isConferenceServerAllowExternal()

setConferenceServerAllowExternal

public void setConferenceServerAllowExternal(boolean value)

getConferenceServerPassword

public java.lang.String getConferenceServerPassword()

setConferenceServerPassword

public void setConferenceServerPassword(java.lang.String value)

getItemProperties

public ItemPropertiesCollection getItemProperties()

getDownloadState

public DownloadState getDownloadState()

showCategoriesDialog

public void showCategoriesDialog()

getInternetCodepage

public int getInternetCodepage()
The 'InternetCodepage' property is only supported by Outlook 2002 or higher. With other versions this method will throw an ComponentObjectModelException.


setInternetCodepage

public void setInternetCodepage(int value)
The 'InternetCodepage' property is only supported by Outlook 2002 or higher. With other versions this method will throw an ComponentObjectModelException.


getMarkForDownload

public RemoteStatus getMarkForDownload()

setMarkForDownload

public void setMarkForDownload(RemoteStatus value)

isConflict

public boolean isConflict()

getMeetingWorkspaceURL

public java.lang.String getMeetingWorkspaceURL()
The 'MeetingWorkspaceURL' property is only supported by Outlook 2003 or higher. With other versions this method will throw an ComponentObjectModelException.


isAutoResolvedWinner

public boolean isAutoResolvedWinner()

getConflicts

public ConflictsCollection getConflicts()

getSendUsingAccount

public Account getSendUsingAccount()
Returns the account used when sending this message. The accounts are only supported by Outlook 2007 or later; with other versions this method will throw an ComponentObjectModelException.
This method is only available in the Professional edition of Java Outlook Connector.


setSendUsingAccount

public void setSendUsingAccount(Account account)
Define the account to be used when sending this message. The accounts are only supported by Outlook 2007 or later; with other versions this method will throw an ComponentObjectModelException.
This method is only available in the Professional edition of Java Outlook Connector.