|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectmicrosoft.exchange.webservices.data.ServiceObject
microsoft.exchange.webservices.data.Item
public class Item
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. |
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. |
String |
getCulture()
Gets the culture associated with this item. |
Date |
getDateTimeCreated()
Gets the date and time this item was created. |
Date |
getDateTimeReceived()
Gets the time when this item was received. |
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. |
String |
getDisplayCc()
Gets a text summarizing the Cc receipients of this item. |
String |
getDisplayTo()
Gets a text summarizing the To recipients of this item. |
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. |
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. |
boolean |
getIsUnmodified()
Gets a value indicating whether the item has been modified since it was created. |
String |
getItemClass()
Gets the custom class name of this item. |
String |
getLastModifiedName()
Gets the name of the user who last modified this item. |
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. |
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. |
String |
getSubject()
Gets the subject. |
UniqueBody |
getUniqueBody()
Gets the body part that is unique to the conversation this item is part of. |
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. |
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(String value)
Sets the culture. |
void |
setExtendedProperty(ExtendedPropertyDefinition extendedPropertyDefinition,
Object value)
Sets the extended property. |
void |
setImportance(Importance value)
Sets the importance. |
void |
setInReplyTo(String value)
Sets the in reply to. |
void |
setIsReminderSet(Boolean value)
Sets the checks if is reminder set. |
void |
setItemClass(String value)
Sets the item class. |
void |
setMimeContent(MimeContent value)
Sets the mime content. |
void |
setReminderDueBy(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(Object subject)
Sets the subject. |
protected void |
setSubject(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 java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
protected Item(ExchangeService service)
throws Exception
service - the service
Exception - the exception
protected Item(ItemAttachment parentAttachment)
throws Exception
parentAttachment - The parent attachment.
Exception - the exception| Method Detail |
|---|
public static Item bind(ExchangeService service,
ItemId id,
PropertySet propertySet)
throws Exception
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.
Exception - the exception
public static Item bind(ExchangeService service,
ItemId id)
throws Exception
service - The service to use to bind to the item.id - The Id of the item to bind to.
Exception - the exceptionprotected ServiceObjectSchema getSchema()
getSchema in class ServiceObjectprotected ExchangeVersion getMinimumRequiredServerVersion()
getMinimumRequiredServerVersion in class ServiceObject
protected void throwIfThisIsAttachment()
throws InvalidOperationException
InvalidOperationException - the invalid operation exceptionprotected PropertyDefinition getIdPropertyDefinition()
getIdPropertyDefinition in class ServiceObject
protected void internalLoad(PropertySet propertySet)
throws Exception
internalLoad in class ServiceObjectpropertySet - the property set
Exception - the exception
protected void internalDelete(DeleteMode deleteMode,
SendCancellationsMode sendCancellationsMode,
AffectedTaskOccurrence affectedTaskOccurrences)
throws ServiceLocalException,
Exception
internalDelete in class ServiceObjectdeleteMode - the delete modesendCancellationsMode - the send cancellations modeaffectedTaskOccurrences - the affected task occurrences
ServiceLocalException - the service local exception
Exception - the exception
protected void internalCreate(FolderId parentFolderId,
MessageDisposition messageDisposition,
SendInvitationsMode sendInvitationsMode)
throws Exception
parentFolderId - the parent folder idmessageDisposition - the message dispositionsendInvitationsMode - the send invitations mode
Exception - the exception
protected Item internalUpdate(FolderId parentFolderId,
ConflictResolutionMode conflictResolutionMode,
MessageDisposition messageDisposition,
SendInvitationsOrCancellationsMode sendInvitationsOrCancellationsMode)
throws ServiceResponseException,
Exception
parentFolderId - the parent folder idconflictResolutionMode - the conflict resolution modemessageDisposition - the message dispositionsendInvitationsOrCancellationsMode - the send invitations or cancellations mode
ServiceResponseException - the service response exception
Exception - the exception
protected boolean hasUnprocessedAttachmentChanges()
throws ServiceLocalException
ServiceLocalExceptionprotected ItemAttachment getParentAttachment()
protected ItemId getRootItemId()
throws ServiceLocalException
ServiceLocalException - the service local exception
public void delete(DeleteMode deleteMode)
throws ServiceLocalException,
Exception
deleteMode - the delete mode
ServiceLocalException - the service local exception
Exception - the exception
public void save(FolderId parentFolderId)
throws Exception
parentFolderId - the parent folder id
Exception - the exception
public void save(WellKnownFolderName parentFolderName)
throws Exception
parentFolderName - the parent folder name
Exception - the exception
public void save()
throws Exception
Exception - the exception
public void update(ConflictResolutionMode conflictResolutionMode)
throws ServiceResponseException,
Exception
conflictResolutionMode - the conflict resolution mode
ServiceResponseException - the service response exception
Exception - the exception
public Item copy(FolderId destinationFolderId)
throws Exception
destinationFolderId - the destination folder id
Exception - the exception
public Item copy(WellKnownFolderName destinationFolderName)
throws Exception
destinationFolderName - the destination folder name
Exception - the exception
public Item move(FolderId destinationFolderId)
throws Exception
destinationFolderId - the destination folder id
Exception - the exception
public Item move(WellKnownFolderName destinationFolderName)
throws Exception
destinationFolderName - the destination folder name
Exception - the exception
public void setExtendedProperty(ExtendedPropertyDefinition extendedPropertyDefinition,
Object value)
throws Exception
extendedPropertyDefinition - the extended property definitionvalue - the value
Exception - the exception
public boolean removeExtendedProperty(ExtendedPropertyDefinition extendedPropertyDefinition)
throws Exception
extendedPropertyDefinition - the extended property definition
Exception - the exception
protected void validate()
throws Exception
validate in class ServiceObjectException - the exceptionpublic boolean isAttachment()
public boolean getIsNew()
throws ServiceLocalException
ServiceLocalException - the service local exception
public ItemId getId()
throws ServiceLocalException
getId in class ServiceObjectServiceLocalException - the service local exception
public MimeContent getMimeContent()
throws ServiceLocalException
ServiceLocalException - the service local exception
public void setMimeContent(MimeContent value)
throws Exception
value - the new mime content
Exception - the exception
public FolderId getParentFolderId()
throws ServiceLocalException
ServiceLocalException - the service local exception
public Sensitivity getSensitivity()
throws ServiceLocalException
ServiceLocalException - the service local exception
public void setSensitivity(Sensitivity value)
throws Exception
value - the new sensitivity
Exception - the exception
public AttachmentCollection getAttachments()
throws ServiceLocalException
ServiceLocalException - the service local exception
public Date getDateTimeReceived()
throws ServiceLocalException
ServiceLocalException - the service local exception
public int getSize()
throws ServiceLocalException
ServiceLocalException - the service local exception
public StringList getCategories()
throws ServiceLocalException
ServiceLocalException - the service local exception
public void setCategories(StringList value)
throws Exception
value - the new categories
Exception - the exception
public String getCulture()
throws ServiceLocalException
ServiceLocalException - the service local exception
public void setCulture(String value)
throws Exception
value - the new culture
Exception - the exception
public Importance getImportance()
throws ServiceLocalException
ServiceLocalException - the service local exception
public void setImportance(Importance value)
throws Exception
value - the new importance
Exception - the exception
public String getInReplyTo()
throws ServiceLocalException
ServiceLocalException - the service local exception
public void setInReplyTo(String value)
throws Exception
value - the new in reply to
Exception - the exception
public boolean getIsSubmitted()
throws ServiceLocalException
ServiceLocalException - the service local exception
public boolean getIsAssociated()
throws ServiceLocalException
ServiceLocalException - the service local exception
public boolean getIsDraft()
throws ServiceLocalException
ServiceLocalException - the service local exception
public boolean getIsFromMe()
throws ServiceLocalException
ServiceLocalException - the service local exception
public boolean getIsResend()
throws ServiceLocalException
ServiceLocalException - the service local exception
public boolean getIsUnmodified()
throws ServiceLocalException
ServiceLocalException - the service local exception
public InternetMessageHeaderCollection getInternetMessageHeaders()
throws ServiceLocalException
ServiceLocalException - the service local exception
public Date getDateTimeSent()
throws ServiceLocalException
ServiceLocalException - the service local exception
public Date getDateTimeCreated()
throws ServiceLocalException
ServiceLocalException - the service local exception
public EnumSet<ResponseActions> getAllowedResponseActions()
throws ServiceLocalException
ServiceLocalException - the service local exception
public Date getReminderDueBy()
throws ServiceLocalException
ServiceLocalException - the service local exception
public void setReminderDueBy(Date value)
throws Exception
value - the new reminder due by
Exception - the exception
public boolean getIsReminderSet()
throws ServiceLocalException
ServiceLocalException - the service local exception
public void setIsReminderSet(Boolean value)
throws Exception
value - the new checks if is reminder set
Exception - the exception
public int getReminderMinutesBeforeStart()
throws ServiceLocalException
ServiceLocalException - the service local exception
public void setReminderMinutesBeforeStart(int value)
throws Exception
value - the new reminder minutes before start
Exception - the exception
public String getDisplayCc()
throws ServiceLocalException
ServiceLocalException - the service local exception
public String getDisplayTo()
throws ServiceLocalException
ServiceLocalException - the service local exception
public boolean getHasAttachments()
throws ServiceLocalException
ServiceLocalException - the service local exception
public MessageBody getBody()
throws ServiceLocalException
ServiceLocalException - the service local exception
public void setBody(MessageBody value)
throws Exception
value - the new body
Exception - the exception
public String getItemClass()
throws ServiceLocalException
ServiceLocalException - the service local exception
public void setItemClass(String value)
throws Exception
value - the new item class
Exception - the exception
protected void setSubject(String subject)
throws Exception
subject - the new subject
Exception - the exception
public void setSubject(Object subject)
throws Exception
subject - the new subject
Exception - the exception
public String getSubject()
throws ServiceLocalException
ServiceLocalException - the service local exception
public String getWebClientReadFormQueryString()
throws ServiceLocalException
ServiceLocalException - the service local exception
public String getWebClientEditFormQueryString()
throws ServiceLocalException
ServiceLocalException - the service local exception
public ExtendedPropertyCollection getExtendedProperties()
throws ServiceLocalException
getExtendedProperties in class ServiceObjectServiceLocalException - the service local exception
public EnumSet<EffectiveRights> getEffectiveRights()
throws ServiceLocalException
ServiceLocalException - the service local exception
public String getLastModifiedName()
throws ServiceLocalException
ServiceLocalException - the service local exception
public Date getLastModifiedTime()
throws ServiceLocalException
ServiceLocalException - the service local exception
public ConversationId getConversationId()
throws ServiceLocalException
ServiceLocalException - the service local exception
public UniqueBody getUniqueBody()
throws ServiceLocalException
ServiceLocalException - the service local exceptionprotected AffectedTaskOccurrence getDefaultAffectedTaskOccurrences()
protected SendCancellationsMode getDefaultSendCancellationsMode()
protected SendInvitationsMode getDefaultSendInvitationsMode()
protected SendInvitationsOrCancellationsMode getDefaultSendInvitationsOrCancellationsMode()
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||