microsoft.exchange.webservices.data
Class Item

java.lang.Object
  extended by microsoft.exchange.webservices.data.ServiceObject
      extended by microsoft.exchange.webservices.data.Item
Direct Known Subclasses:
Appointment, Contact, ContactGroup, EmailMessage, PostItem, Task

public class Item
extends ServiceObject

Represents a generic item. Properties available on items are defined in the ItemSchema class.


Constructor Summary
protected Item(ExchangeService service)
          Initializes an unsaved local instance of .
protected Item(ItemAttachment parentAttachment)
          Initializes a new instance of the item class.
 
Method Summary
static Item bind(ExchangeService service, ItemId id)
          Binds to an existing item, whatever its actual type is, and loads the specified set of properties.
static Item bind(ExchangeService service, ItemId id, PropertySet propertySet)
          Binds to an existing item, whatever its actual type is, and loads the specified set of properties.
 Item copy(FolderId destinationFolderId)
          Creates a copy of this item in the specified folder.
 Item copy(WellKnownFolderName destinationFolderName)
          Creates a copy of this item in the specified folder.
 void delete(DeleteMode deleteMode)
          Deletes the item.
 java.util.EnumSet<ResponseActions> getAllowedResponseActions()
          Gets a value indicating which response actions are allowed on this item.
 AttachmentCollection getAttachments()
          Gets a list of the attachments to this item.
 MessageBody getBody()
          Gets the body of this item.
 StringList getCategories()
          Gets the list of categories associated with this item.
 ConversationId getConversationId()
          Gets the Id of the conversation this item is part of.
 java.lang.String getCulture()
          Gets the culture associated with this item.
 java.util.Date getDateTimeCreated()
          Gets the date and time this item was created.
 java.util.Date getDateTimeReceived()
          Gets the time when this item was received.
 java.util.Date getDateTimeSent()
          Gets the date and time this item was sent.
protected  AffectedTaskOccurrence getDefaultAffectedTaskOccurrences()
          Gets the default setting for how to treat affected task occurrences on Delete.
protected  SendCancellationsMode getDefaultSendCancellationsMode()
          Gets the default setting for sending cancellations on Delete.
protected  SendInvitationsMode getDefaultSendInvitationsMode()
          Gets the default settings for sending invitations on Save.
protected  SendInvitationsOrCancellationsMode getDefaultSendInvitationsOrCancellationsMode()
          Gets the default settings for sending invitations or cancellations on Update.
 java.lang.String getDisplayCc()
          Gets a text summarizing the Cc receipients of this item.
 java.lang.String getDisplayTo()
          Gets a text summarizing the To recipients of this item.
 java.util.EnumSet<EffectiveRights> getEffectiveRights()
          Gets a value indicating the effective rights the current authenticated user has on this item.
 ExtendedPropertyCollection getExtendedProperties()
          Gets a list of extended properties defined on this item.
 boolean getHasAttachments()
          Gets a value indicating whether the item has attachments.
 ItemId getId()
          Gets the Id of this item.
protected  PropertyDefinition getIdPropertyDefinition()
          The property definition for the Id of this object.
 Importance getImportance()
          Gets the importance of this item.
 java.lang.String getInReplyTo()
          Gets the In-Reply-To reference of this item.
 InternetMessageHeaderCollection getInternetMessageHeaders()
          Gets a list of Internet headers for this item.
 boolean getIsAssociated()
          Gets a value indicating whether the message has been submitted to be sent.
 boolean getIsDraft()
          Gets a value indicating whether the message has been submitted to be sent.
 boolean getIsFromMe()
          Gets a value indicating whether the item has been sent by the current authenticated user.
 boolean getIsNew()
          Gets a value indicating whether this object is a real store item, or if it's a local object that has yet to be saved.
 boolean getIsReminderSet()
          Gets a value indicating whether a reminder is set for this item.
 boolean getIsResend()
          Gets a value indicating whether the item is a resend of another item.
 boolean getIsSubmitted()
          Gets a value indicating whether the message has been submitted to be sent.
protected  boolean getIsTimeZoneHeaderRequired(boolean isUpdateOperation)
          Gets a value indicating whether a time zone SOAP header should be emitted in a CreateItem or UpdateItem request so this item can be property saved or updated.
 boolean getIsUnmodified()
          Gets a value indicating whether the item has been modified since it was created.
 java.lang.String getItemClass()
          Gets the custom class name of this item.
 java.lang.String getLastModifiedName()
          Gets the name of the user who last modified this item.
 java.util.Date getLastModifiedTime()
          Gets the date and time this item was last modified.
 MimeContent getMimeContent()
          Get the MIME content of this item.
protected  ExchangeVersion getMinimumRequiredServerVersion()
          Gets the minimum required server version.
protected  ItemAttachment getParentAttachment()
          Gets the parent attachment of this item.
 FolderId getParentFolderId()
          Gets the Id of the parent folder of this item.
 java.util.Date getReminderDueBy()
          Gets the date and time when the reminder is due for this item.
 int getReminderMinutesBeforeStart()
          Gets the number of minutes before the start of this item when the reminder should be triggered.
protected  ItemId getRootItemId()
          Gets Id of the root item for this item.
protected  ServiceObjectSchema getSchema()
          Internal method to return the schema associated with this type of object.
 Sensitivity getSensitivity()
          Gets the sensitivity of this item.
 int getSize()
          Gets the size of this item.
 java.lang.String getSubject()
          Gets the subject.
 UniqueBody getUniqueBody()
          Gets the body part that is unique to the conversation this item is part of.
 java.lang.String getWebClientEditFormQueryString()
          Gets the query string that should be appended to the Exchange Web client URL to open this item using the appropriate read form in a web browser.
 java.lang.String getWebClientReadFormQueryString()
          Gets the query string that should be appended to the Exchange Web client URL to open this item using the appropriate read form in a web browser.
protected  boolean hasUnprocessedAttachmentChanges()
          Gets a value indicating whether this instance has unprocessed attachment collection changes.
protected  void internalCreate(FolderId parentFolderId, MessageDisposition messageDisposition, SendInvitationsMode sendInvitationsMode)
          Create item.
protected  void internalDelete(DeleteMode deleteMode, SendCancellationsMode sendCancellationsMode, AffectedTaskOccurrence affectedTaskOccurrences)
          Deletes the object.
protected  void internalLoad(PropertySet propertySet)
          The property definition for the Id of this object.
protected  Item internalUpdate(FolderId parentFolderId, ConflictResolutionMode conflictResolutionMode, MessageDisposition messageDisposition, SendInvitationsOrCancellationsMode sendInvitationsOrCancellationsMode)
          Update item.
 boolean isAttachment()
          Gets a value indicating whether the item is an attachment.
 Item move(FolderId destinationFolderId)
          Moves this item to a the specified folder.
 Item move(WellKnownFolderName destinationFolderName)
          Moves this item to a the specified folder.
 boolean removeExtendedProperty(ExtendedPropertyDefinition extendedPropertyDefinition)
          Removes an extended property.
 void save()
          Saves this item in the default folder based on the item's type (for example, an e-mail message is saved to the Drafts folder).
 void save(FolderId parentFolderId)
          Saves this item in a specific folder.
 void save(WellKnownFolderName parentFolderName)
          Saves this item in a specific folder.
 void setBody(MessageBody value)
          Sets the body.
 void setCategories(StringList value)
          Sets the categories.
 void setCulture(java.lang.String value)
          Sets the culture.
 void setExtendedProperty(ExtendedPropertyDefinition extendedPropertyDefinition, java.lang.Object value)
          Sets the extended property.
 void setImportance(Importance value)
          Sets the importance.
 void setInReplyTo(java.lang.String value)
          Sets the in reply to.
 void setIsReminderSet(java.lang.Boolean value)
          Sets the checks if is reminder set.
 void setItemClass(java.lang.String value)
          Sets the item class.
 void setMimeContent(MimeContent value)
          Sets the mime content.
 void setReminderDueBy(java.util.Date value)
          Sets the reminder due by.
 void setReminderMinutesBeforeStart(int value)
          Sets the reminder minutes before start.
 void setSensitivity(Sensitivity value)
          Sets the sensitivity.
 void setSubject(java.lang.Object subject)
          Sets the subject.
protected  void setSubject(java.lang.String subject)
          Gets the subject of this item.
protected  void throwIfThisIsAttachment()
          Throws exception if this is attachment.
 void update(ConflictResolutionMode conflictResolutionMode)
          Applies the local changes that have been made to this item.
protected  void validate()
          Validates this instance.
 
Methods inherited from class microsoft.exchange.webservices.data.ServiceObject
addServiceObjectChangedEvent, changed, clearChangeLog, clearServiceObjectChangedEvent, getChangeXmlElementName, getDeleteFieldXmlElementName, getIsCustomDateTimeScopingRequired, getLoadedPropertyDefinitions, getObjectFromPropertyDefinition, getPropertyBag, getService, getSetFieldXmlElementName, getXmlElementName, getXmlElementNameOverride, isDirty, isNew, load, load, loadFromXml, loadFromXml, removeServiceObjectChangedEvent, schema, setService, throwIfThisIsNew, throwIfThisIsNotNew, tryGetExtendedProperty, tryGetProperty, tryGetProperty, writeToXml, writeToXmlForUpdate
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Item

protected Item(ExchangeService service)
        throws java.lang.Exception
Initializes an unsaved local instance of . To bind to an existing item, use Item.Bind() instead.

Parameters:
service - the service
Throws:
java.lang.Exception - the exception

Item

protected Item(ItemAttachment parentAttachment)
        throws java.lang.Exception
Initializes a new instance of the item class.

Parameters:
parentAttachment - The parent attachment.
Throws:
java.lang.Exception - the exception
Method Detail

bind

public static Item bind(ExchangeService service,
                        ItemId id,
                        PropertySet propertySet)
                 throws java.lang.Exception
Binds to an existing item, whatever its actual type is, and loads the specified set of properties. Calling this method results in a call to EWS.

Parameters:
service - The service to use to bind to the item.
id - The Id of the item to bind to.
propertySet - The set of properties to load.
Returns:
An Item instance representing the item corresponding to the specified Id.
Throws:
java.lang.Exception - the exception

bind

public static Item bind(ExchangeService service,
                        ItemId id)
                 throws java.lang.Exception
Binds to an existing item, whatever its actual type is, and loads the specified set of properties. Calling this method results in a call to EWS.

Parameters:
service - The service to use to bind to the item.
id - The Id of the item to bind to.
Returns:
An Item instance representing the item corresponding to the specified Id.
Throws:
java.lang.Exception - the exception

getSchema

protected ServiceObjectSchema getSchema()
Internal method to return the schema associated with this type of object.

Specified by:
getSchema in class ServiceObject
Returns:
The schema associated with this type of object.

getMinimumRequiredServerVersion

protected ExchangeVersion getMinimumRequiredServerVersion()
Gets the minimum required server version.

Specified by:
getMinimumRequiredServerVersion in class ServiceObject
Returns:
Earliest Exchange version in which this service object type is supported.

throwIfThisIsAttachment

protected void throwIfThisIsAttachment()
                                throws InvalidOperationException
Throws exception if this is attachment.

Throws:
InvalidOperationException - the invalid operation exception

getIdPropertyDefinition

protected PropertyDefinition getIdPropertyDefinition()
The property definition for the Id of this object.

Overrides:
getIdPropertyDefinition in class ServiceObject
Returns:
A PropertyDefinition instance.

internalLoad

protected void internalLoad(PropertySet propertySet)
                     throws java.lang.Exception
The property definition for the Id of this object.

Specified by:
internalLoad in class ServiceObject
Parameters:
propertySet - the property set
Throws:
java.lang.Exception - the exception

internalDelete

protected void internalDelete(DeleteMode deleteMode,
                              SendCancellationsMode sendCancellationsMode,
                              AffectedTaskOccurrence affectedTaskOccurrences)
                       throws ServiceLocalException,
                              java.lang.Exception
Deletes the object.

Specified by:
internalDelete in class ServiceObject
Parameters:
deleteMode - the delete mode
sendCancellationsMode - the send cancellations mode
affectedTaskOccurrences - the affected task occurrences
Throws:
ServiceLocalException - the service local exception
java.lang.Exception - the exception

internalCreate

protected void internalCreate(FolderId parentFolderId,
                              MessageDisposition messageDisposition,
                              SendInvitationsMode sendInvitationsMode)
                       throws java.lang.Exception
Create item.

Parameters:
parentFolderId - the parent folder id
messageDisposition - the message disposition
sendInvitationsMode - the send invitations mode
Throws:
java.lang.Exception - the exception

internalUpdate

protected Item internalUpdate(FolderId parentFolderId,
                              ConflictResolutionMode conflictResolutionMode,
                              MessageDisposition messageDisposition,
                              SendInvitationsOrCancellationsMode sendInvitationsOrCancellationsMode)
                       throws ServiceResponseException,
                              java.lang.Exception
Update item.

Parameters:
parentFolderId - the parent folder id
conflictResolutionMode - the conflict resolution mode
messageDisposition - the message disposition
sendInvitationsOrCancellationsMode - the send invitations or cancellations mode
Returns:
Updated item.
Throws:
ServiceResponseException - the service response exception
java.lang.Exception - the exception

hasUnprocessedAttachmentChanges

protected boolean hasUnprocessedAttachmentChanges()
                                           throws ServiceLocalException
Gets a value indicating whether this instance has unprocessed attachment collection changes.

Throws:
ServiceLocalException

getParentAttachment

protected ItemAttachment getParentAttachment()
Gets the parent attachment of this item.

Returns:
the parent attachment

getRootItemId

protected ItemId getRootItemId()
                        throws ServiceLocalException
Gets Id of the root item for this item.

Returns:
the root item id
Throws:
ServiceLocalException - the service local exception

delete

public void delete(DeleteMode deleteMode)
            throws ServiceLocalException,
                   java.lang.Exception
Deletes the item. Calling this method results in a call to EWS.

Parameters:
deleteMode - the delete mode
Throws:
ServiceLocalException - the service local exception
java.lang.Exception - the exception

save

public void save(FolderId parentFolderId)
          throws java.lang.Exception
Saves this item in a specific folder. Calling this method results in at least one call to EWS. Mutliple calls to EWS might be made if attachments have been added.

Parameters:
parentFolderId - the parent folder id
Throws:
java.lang.Exception - the exception

save

public void save(WellKnownFolderName parentFolderName)
          throws java.lang.Exception
Saves this item in a specific folder. Calling this method results in at least one call to EWS. Mutliple calls to EWS might be made if attachments have been added.

Parameters:
parentFolderName - the parent folder name
Throws:
java.lang.Exception - the exception

save

public void save()
          throws java.lang.Exception
Saves this item in the default folder based on the item's type (for example, an e-mail message is saved to the Drafts folder). Calling this method results in at least one call to EWS. Mutliple calls to EWS might be made if attachments have been added.

Throws:
java.lang.Exception - the exception

update

public void update(ConflictResolutionMode conflictResolutionMode)
            throws ServiceResponseException,
                   java.lang.Exception
Applies the local changes that have been made to this item. Calling this method results in at least one call to EWS. Mutliple calls to EWS might be made if attachments have been added or removed.

Parameters:
conflictResolutionMode - the conflict resolution mode
Throws:
ServiceResponseException - the service response exception
java.lang.Exception - the exception

copy

public Item copy(FolderId destinationFolderId)
          throws java.lang.Exception
Creates a copy of this item in the specified folder. Calling this method results in a call to EWS. Copy returns null if the copy operation is across two mailboxes or between a mailbox and a public folder.

Parameters:
destinationFolderId - the destination folder id
Returns:
The copy of this item.
Throws:
java.lang.Exception - the exception

copy

public Item copy(WellKnownFolderName destinationFolderName)
          throws java.lang.Exception
Creates a copy of this item in the specified folder. Calling this method results in a call to EWS. Copy returns null if the copy operation is across two mailboxes or between a mailbox and a public folder.

Parameters:
destinationFolderName - the destination folder name
Returns:
The copy of this item.
Throws:
java.lang.Exception - the exception

move

public Item move(FolderId destinationFolderId)
          throws java.lang.Exception
Moves this item to a the specified folder. Calling this method results in a call to EWS. Move returns null if the move operation is across two mailboxes or between a mailbox and a public folder.

Parameters:
destinationFolderId - the destination folder id
Returns:
The moved copy of this item.
Throws:
java.lang.Exception - the exception

move

public Item move(WellKnownFolderName destinationFolderName)
          throws java.lang.Exception
Moves this item to a the specified folder. Calling this method results in a call to EWS. Move returns null if the move operation is across two mailboxes or between a mailbox and a public folder.

Parameters:
destinationFolderName - the destination folder name
Returns:
The moved copy of this item.
Throws:
java.lang.Exception - the exception

setExtendedProperty

public void setExtendedProperty(ExtendedPropertyDefinition extendedPropertyDefinition,
                                java.lang.Object value)
                         throws java.lang.Exception
Sets the extended property.

Parameters:
extendedPropertyDefinition - the extended property definition
value - the value
Throws:
java.lang.Exception - the exception

removeExtendedProperty

public boolean removeExtendedProperty(ExtendedPropertyDefinition extendedPropertyDefinition)
                               throws java.lang.Exception
Removes an extended property.

Parameters:
extendedPropertyDefinition - the extended property definition
Returns:
True if property was removed.
Throws:
java.lang.Exception - the exception

validate

protected void validate()
                 throws java.lang.Exception
Validates this instance.

Overrides:
validate in class ServiceObject
Throws:
java.lang.Exception - the exception

getIsTimeZoneHeaderRequired

protected boolean getIsTimeZoneHeaderRequired(boolean isUpdateOperation)
                                       throws java.lang.Exception
Gets a value indicating whether a time zone SOAP header should be emitted in a CreateItem or UpdateItem request so this item can be property saved or updated.

Overrides:
getIsTimeZoneHeaderRequired in class ServiceObject
Parameters:
isUpdateOperation - Indicates whether the operation being petrformed is an update operation.
Returns:
true if a time zone SOAP header should be emitted; otherwise,false
Throws:
java.lang.Exception

isAttachment

public boolean isAttachment()
Gets a value indicating whether the item is an attachment.

Returns:
true, if is attachment

getIsNew

public boolean getIsNew()
                 throws ServiceLocalException
Gets a value indicating whether this object is a real store item, or if it's a local object that has yet to be saved.

Returns:
the checks if is new
Throws:
ServiceLocalException - the service local exception

getId

public ItemId getId()
             throws ServiceLocalException
Gets the Id of this item.

Overrides:
getId in class ServiceObject
Returns:
the id
Throws:
ServiceLocalException - the service local exception

getMimeContent

public MimeContent getMimeContent()
                           throws ServiceLocalException
Get the MIME content of this item.

Returns:
the mime content
Throws:
ServiceLocalException - the service local exception

setMimeContent

public void setMimeContent(MimeContent value)
                    throws java.lang.Exception
Sets the mime content.

Parameters:
value - the new mime content
Throws:
java.lang.Exception - the exception

getParentFolderId

public FolderId getParentFolderId()
                           throws ServiceLocalException
Gets the Id of the parent folder of this item.

Returns:
the parent folder id
Throws:
ServiceLocalException - the service local exception

getSensitivity

public Sensitivity getSensitivity()
                           throws ServiceLocalException
Gets the sensitivity of this item.

Returns:
the sensitivity
Throws:
ServiceLocalException - the service local exception

setSensitivity

public void setSensitivity(Sensitivity value)
                    throws java.lang.Exception
Sets the sensitivity.

Parameters:
value - the new sensitivity
Throws:
java.lang.Exception - the exception

getAttachments

public AttachmentCollection getAttachments()
                                    throws ServiceLocalException
Gets a list of the attachments to this item.

Returns:
the attachments
Throws:
ServiceLocalException - the service local exception

getDateTimeReceived

public java.util.Date getDateTimeReceived()
                                   throws ServiceLocalException
Gets the time when this item was received.

Returns:
the date time received
Throws:
ServiceLocalException - the service local exception

getSize

public int getSize()
            throws ServiceLocalException
Gets the size of this item.

Returns:
the size
Throws:
ServiceLocalException - the service local exception

getCategories

public StringList getCategories()
                         throws ServiceLocalException
Gets the list of categories associated with this item.

Returns:
the categories
Throws:
ServiceLocalException - the service local exception

setCategories

public void setCategories(StringList value)
                   throws java.lang.Exception
Sets the categories.

Parameters:
value - the new categories
Throws:
java.lang.Exception - the exception

getCulture

public java.lang.String getCulture()
                            throws ServiceLocalException
Gets the culture associated with this item.

Returns:
the culture
Throws:
ServiceLocalException - the service local exception

setCulture

public void setCulture(java.lang.String value)
                throws java.lang.Exception
Sets the culture.

Parameters:
value - the new culture
Throws:
java.lang.Exception - the exception

getImportance

public Importance getImportance()
                         throws ServiceLocalException
Gets the importance of this item.

Returns:
the importance
Throws:
ServiceLocalException - the service local exception

setImportance

public void setImportance(Importance value)
                   throws java.lang.Exception
Sets the importance.

Parameters:
value - the new importance
Throws:
java.lang.Exception - the exception

getInReplyTo

public java.lang.String getInReplyTo()
                              throws ServiceLocalException
Gets the In-Reply-To reference of this item.

Returns:
the in reply to
Throws:
ServiceLocalException - the service local exception

setInReplyTo

public void setInReplyTo(java.lang.String value)
                  throws java.lang.Exception
Sets the in reply to.

Parameters:
value - the new in reply to
Throws:
java.lang.Exception - the exception

getIsSubmitted

public boolean getIsSubmitted()
                       throws ServiceLocalException
Gets a value indicating whether the message has been submitted to be sent.

Returns:
the checks if is submitted
Throws:
ServiceLocalException - the service local exception

getIsAssociated

public boolean getIsAssociated()
                        throws ServiceLocalException
Gets a value indicating whether the message has been submitted to be sent.

Returns:
the checks if is associated
Throws:
ServiceLocalException - the service local exception

getIsDraft

public boolean getIsDraft()
                   throws ServiceLocalException
Gets a value indicating whether the message has been submitted to be sent.

Returns:
the checks if is draft
Throws:
ServiceLocalException - the service local exception

getIsFromMe

public boolean getIsFromMe()
                    throws ServiceLocalException
Gets a value indicating whether the item has been sent by the current authenticated user.

Returns:
the checks if is from me
Throws:
ServiceLocalException - the service local exception

getIsResend

public boolean getIsResend()
                    throws ServiceLocalException
Gets a value indicating whether the item is a resend of another item.

Returns:
the checks if is resend
Throws:
ServiceLocalException - the service local exception

getIsUnmodified

public boolean getIsUnmodified()
                        throws ServiceLocalException
Gets a value indicating whether the item has been modified since it was created.

Returns:
the checks if is unmodified
Throws:
ServiceLocalException - the service local exception

getInternetMessageHeaders

public InternetMessageHeaderCollection getInternetMessageHeaders()
                                                          throws ServiceLocalException
Gets a list of Internet headers for this item.

Returns:
the internet message headers
Throws:
ServiceLocalException - the service local exception

getDateTimeSent

public java.util.Date getDateTimeSent()
                               throws ServiceLocalException
Gets the date and time this item was sent.

Returns:
the date time sent
Throws:
ServiceLocalException - the service local exception

getDateTimeCreated

public java.util.Date getDateTimeCreated()
                                  throws ServiceLocalException
Gets the date and time this item was created.

Returns:
the date time created
Throws:
ServiceLocalException - the service local exception

getAllowedResponseActions

public java.util.EnumSet<ResponseActions> getAllowedResponseActions()
                                                             throws ServiceLocalException
Gets a value indicating which response actions are allowed on this item. Examples of response actions are Reply and Forward.

Returns:
the allowed response actions
Throws:
ServiceLocalException - the service local exception

getReminderDueBy

public java.util.Date getReminderDueBy()
                                throws ServiceLocalException
Gets the date and time when the reminder is due for this item.

Returns:
the reminder due by
Throws:
ServiceLocalException - the service local exception

setReminderDueBy

public void setReminderDueBy(java.util.Date value)
                      throws java.lang.Exception
Sets the reminder due by.

Parameters:
value - the new reminder due by
Throws:
java.lang.Exception - the exception

getIsReminderSet

public boolean getIsReminderSet()
                         throws ServiceLocalException
Gets a value indicating whether a reminder is set for this item.

Returns:
the checks if is reminder set
Throws:
ServiceLocalException - the service local exception

setIsReminderSet

public void setIsReminderSet(java.lang.Boolean value)
                      throws java.lang.Exception
Sets the checks if is reminder set.

Parameters:
value - the new checks if is reminder set
Throws:
java.lang.Exception - the exception

getReminderMinutesBeforeStart

public int getReminderMinutesBeforeStart()
                                  throws ServiceLocalException
Gets the number of minutes before the start of this item when the reminder should be triggered.

Returns:
the reminder minutes before start
Throws:
ServiceLocalException - the service local exception

setReminderMinutesBeforeStart

public void setReminderMinutesBeforeStart(int value)
                                   throws java.lang.Exception
Sets the reminder minutes before start.

Parameters:
value - the new reminder minutes before start
Throws:
java.lang.Exception - the exception

getDisplayCc

public java.lang.String getDisplayCc()
                              throws ServiceLocalException
Gets a text summarizing the Cc receipients of this item.

Returns:
the display cc
Throws:
ServiceLocalException - the service local exception

getDisplayTo

public java.lang.String getDisplayTo()
                              throws ServiceLocalException
Gets a text summarizing the To recipients of this item.

Returns:
the display to
Throws:
ServiceLocalException - the service local exception

getHasAttachments

public boolean getHasAttachments()
                          throws ServiceLocalException
Gets a value indicating whether the item has attachments.

Returns:
the checks for attachments
Throws:
ServiceLocalException - the service local exception

getBody

public MessageBody getBody()
                    throws ServiceLocalException
Gets the body of this item.

Returns:
MessageBody
Throws:
ServiceLocalException - the service local exception

setBody

public void setBody(MessageBody value)
             throws java.lang.Exception
Sets the body.

Parameters:
value - the new body
Throws:
java.lang.Exception - the exception

getItemClass

public java.lang.String getItemClass()
                              throws ServiceLocalException
Gets the custom class name of this item.

Returns:
the item class
Throws:
ServiceLocalException - the service local exception

setItemClass

public void setItemClass(java.lang.String value)
                  throws java.lang.Exception
Sets the item class.

Parameters:
value - the new item class
Throws:
java.lang.Exception - the exception

setSubject

protected void setSubject(java.lang.String subject)
                   throws java.lang.Exception
Gets the subject of this item.

Parameters:
subject - the new subject
Throws:
java.lang.Exception - the exception

setSubject

public void setSubject(java.lang.Object subject)
                throws java.lang.Exception
Sets the subject.

Parameters:
subject - the new subject
Throws:
java.lang.Exception - the exception

getSubject

public java.lang.String getSubject()
                            throws ServiceLocalException
Gets the subject.

Returns:
the subject
Throws:
ServiceLocalException - the service local exception

getWebClientReadFormQueryString

public java.lang.String getWebClientReadFormQueryString()
                                                 throws ServiceLocalException
Gets the query string that should be appended to the Exchange Web client URL to open this item using the appropriate read form in a web browser.

Returns:
the web client read form query string
Throws:
ServiceLocalException - the service local exception

getWebClientEditFormQueryString

public java.lang.String getWebClientEditFormQueryString()
                                                 throws ServiceLocalException
Gets the query string that should be appended to the Exchange Web client URL to open this item using the appropriate read form in a web browser.

Returns:
the web client edit form query string
Throws:
ServiceLocalException - the service local exception

getExtendedProperties

public ExtendedPropertyCollection getExtendedProperties()
                                                 throws ServiceLocalException
Gets a list of extended properties defined on this item.

Overrides:
getExtendedProperties in class ServiceObject
Returns:
the extended properties
Throws:
ServiceLocalException - the service local exception

getEffectiveRights

public java.util.EnumSet<EffectiveRights> getEffectiveRights()
                                                      throws ServiceLocalException
Gets a value indicating the effective rights the current authenticated user has on this item.

Returns:
the effective rights
Throws:
ServiceLocalException - the service local exception

getLastModifiedName

public java.lang.String getLastModifiedName()
                                     throws ServiceLocalException
Gets the name of the user who last modified this item.

Returns:
the last modified name
Throws:
ServiceLocalException - the service local exception

getLastModifiedTime

public java.util.Date getLastModifiedTime()
                                   throws ServiceLocalException
Gets the date and time this item was last modified.

Returns:
the last modified time
Throws:
ServiceLocalException - the service local exception

getConversationId

public ConversationId getConversationId()
                                 throws ServiceLocalException
Gets the Id of the conversation this item is part of.

Returns:
the conversation id
Throws:
ServiceLocalException - the service local exception

getUniqueBody

public UniqueBody getUniqueBody()
                         throws ServiceLocalException
Gets the body part that is unique to the conversation this item is part of.

Returns:
the unique body
Throws:
ServiceLocalException - the service local exception

getDefaultAffectedTaskOccurrences

protected AffectedTaskOccurrence getDefaultAffectedTaskOccurrences()
Gets the default setting for how to treat affected task occurrences on Delete. Subclasses will override this for different default behavior.

Returns:
the default affected task occurrences

getDefaultSendCancellationsMode

protected SendCancellationsMode getDefaultSendCancellationsMode()
Gets the default setting for sending cancellations on Delete. Subclasses will override this for different default behavior.

Returns:
the default send cancellations mode

getDefaultSendInvitationsMode

protected SendInvitationsMode getDefaultSendInvitationsMode()
Gets the default settings for sending invitations on Save. Subclasses will override this for different default behavior.

Returns:
the default send invitations mode

getDefaultSendInvitationsOrCancellationsMode

protected SendInvitationsOrCancellationsMode getDefaultSendInvitationsOrCancellationsMode()
Gets the default settings for sending invitations or cancellations on Update. Subclasses will override this for different default behavior.

Returns:
the default send invitations or cancellations mode