|
||||||||
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. |
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 java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
protected Item(ExchangeService service) throws java.lang.Exception
service
- the service
java.lang.Exception
- the exceptionprotected Item(ItemAttachment parentAttachment) throws java.lang.Exception
parentAttachment
- The parent attachment.
java.lang.Exception
- the exceptionMethod Detail |
---|
public static Item bind(ExchangeService service, ItemId id, PropertySet propertySet) throws java.lang.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.
java.lang.Exception
- the exceptionpublic static Item bind(ExchangeService service, ItemId id) throws java.lang.Exception
service
- The service to use to bind to the item.id
- The Id of the item to bind to.
java.lang.Exception
- the exceptionprotected ServiceObjectSchema getSchema()
getSchema
in class ServiceObject
protected 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 java.lang.Exception
internalLoad
in class ServiceObject
propertySet
- the property set
java.lang.Exception
- the exceptionprotected void internalDelete(DeleteMode deleteMode, SendCancellationsMode sendCancellationsMode, AffectedTaskOccurrence affectedTaskOccurrences) throws ServiceLocalException, java.lang.Exception
internalDelete
in class ServiceObject
deleteMode
- the delete modesendCancellationsMode
- the send cancellations modeaffectedTaskOccurrences
- the affected task occurrences
ServiceLocalException
- the service local exception
java.lang.Exception
- the exceptionprotected void internalCreate(FolderId parentFolderId, MessageDisposition messageDisposition, SendInvitationsMode sendInvitationsMode) throws java.lang.Exception
parentFolderId
- the parent folder idmessageDisposition
- the message dispositionsendInvitationsMode
- the send invitations mode
java.lang.Exception
- the exceptionprotected Item internalUpdate(FolderId parentFolderId, ConflictResolutionMode conflictResolutionMode, MessageDisposition messageDisposition, SendInvitationsOrCancellationsMode sendInvitationsOrCancellationsMode) throws ServiceResponseException, java.lang.Exception
parentFolderId
- the parent folder idconflictResolutionMode
- the conflict resolution modemessageDisposition
- the message dispositionsendInvitationsOrCancellationsMode
- the send invitations or cancellations mode
ServiceResponseException
- the service response exception
java.lang.Exception
- the exceptionprotected boolean hasUnprocessedAttachmentChanges() throws ServiceLocalException
ServiceLocalException
protected ItemAttachment getParentAttachment()
protected ItemId getRootItemId() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic void delete(DeleteMode deleteMode) throws ServiceLocalException, java.lang.Exception
deleteMode
- the delete mode
ServiceLocalException
- the service local exception
java.lang.Exception
- the exceptionpublic void save(FolderId parentFolderId) throws java.lang.Exception
parentFolderId
- the parent folder id
java.lang.Exception
- the exceptionpublic void save(WellKnownFolderName parentFolderName) throws java.lang.Exception
parentFolderName
- the parent folder name
java.lang.Exception
- the exceptionpublic void save() throws java.lang.Exception
java.lang.Exception
- the exceptionpublic void update(ConflictResolutionMode conflictResolutionMode) throws ServiceResponseException, java.lang.Exception
conflictResolutionMode
- the conflict resolution mode
ServiceResponseException
- the service response exception
java.lang.Exception
- the exceptionpublic Item copy(FolderId destinationFolderId) throws java.lang.Exception
destinationFolderId
- the destination folder id
java.lang.Exception
- the exceptionpublic Item copy(WellKnownFolderName destinationFolderName) throws java.lang.Exception
destinationFolderName
- the destination folder name
java.lang.Exception
- the exceptionpublic Item move(FolderId destinationFolderId) throws java.lang.Exception
destinationFolderId
- the destination folder id
java.lang.Exception
- the exceptionpublic Item move(WellKnownFolderName destinationFolderName) throws java.lang.Exception
destinationFolderName
- the destination folder name
java.lang.Exception
- the exceptionpublic void setExtendedProperty(ExtendedPropertyDefinition extendedPropertyDefinition, java.lang.Object value) throws java.lang.Exception
extendedPropertyDefinition
- the extended property definitionvalue
- the value
java.lang.Exception
- the exceptionpublic boolean removeExtendedProperty(ExtendedPropertyDefinition extendedPropertyDefinition) throws java.lang.Exception
extendedPropertyDefinition
- the extended property definition
java.lang.Exception
- the exceptionprotected void validate() throws java.lang.Exception
validate
in class ServiceObject
java.lang.Exception
- the exceptionprotected boolean getIsTimeZoneHeaderRequired(boolean isUpdateOperation) throws java.lang.Exception
getIsTimeZoneHeaderRequired
in class ServiceObject
isUpdateOperation
- Indicates whether the operation being petrformed is an update
operation.
java.lang.Exception
public boolean isAttachment()
public boolean getIsNew() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic ItemId getId() throws ServiceLocalException
getId
in class ServiceObject
ServiceLocalException
- the service local exceptionpublic MimeContent getMimeContent() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic void setMimeContent(MimeContent value) throws java.lang.Exception
value
- the new mime content
java.lang.Exception
- the exceptionpublic FolderId getParentFolderId() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic Sensitivity getSensitivity() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic void setSensitivity(Sensitivity value) throws java.lang.Exception
value
- the new sensitivity
java.lang.Exception
- the exceptionpublic AttachmentCollection getAttachments() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic java.util.Date getDateTimeReceived() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic int getSize() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic StringList getCategories() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic void setCategories(StringList value) throws java.lang.Exception
value
- the new categories
java.lang.Exception
- the exceptionpublic java.lang.String getCulture() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic void setCulture(java.lang.String value) throws java.lang.Exception
value
- the new culture
java.lang.Exception
- the exceptionpublic Importance getImportance() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic void setImportance(Importance value) throws java.lang.Exception
value
- the new importance
java.lang.Exception
- the exceptionpublic java.lang.String getInReplyTo() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic void setInReplyTo(java.lang.String value) throws java.lang.Exception
value
- the new in reply to
java.lang.Exception
- the exceptionpublic boolean getIsSubmitted() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic boolean getIsAssociated() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic boolean getIsDraft() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic boolean getIsFromMe() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic boolean getIsResend() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic boolean getIsUnmodified() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic InternetMessageHeaderCollection getInternetMessageHeaders() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic java.util.Date getDateTimeSent() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic java.util.Date getDateTimeCreated() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic java.util.EnumSet<ResponseActions> getAllowedResponseActions() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic java.util.Date getReminderDueBy() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic void setReminderDueBy(java.util.Date value) throws java.lang.Exception
value
- the new reminder due by
java.lang.Exception
- the exceptionpublic boolean getIsReminderSet() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic void setIsReminderSet(java.lang.Boolean value) throws java.lang.Exception
value
- the new checks if is reminder set
java.lang.Exception
- the exceptionpublic int getReminderMinutesBeforeStart() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic void setReminderMinutesBeforeStart(int value) throws java.lang.Exception
value
- the new reminder minutes before start
java.lang.Exception
- the exceptionpublic java.lang.String getDisplayCc() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic java.lang.String getDisplayTo() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic boolean getHasAttachments() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic MessageBody getBody() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic void setBody(MessageBody value) throws java.lang.Exception
value
- the new body
java.lang.Exception
- the exceptionpublic java.lang.String getItemClass() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic void setItemClass(java.lang.String value) throws java.lang.Exception
value
- the new item class
java.lang.Exception
- the exceptionprotected void setSubject(java.lang.String subject) throws java.lang.Exception
subject
- the new subject
java.lang.Exception
- the exceptionpublic void setSubject(java.lang.Object subject) throws java.lang.Exception
subject
- the new subject
java.lang.Exception
- the exceptionpublic java.lang.String getSubject() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic java.lang.String getWebClientReadFormQueryString() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic java.lang.String getWebClientEditFormQueryString() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic ExtendedPropertyCollection getExtendedProperties() throws ServiceLocalException
getExtendedProperties
in class ServiceObject
ServiceLocalException
- the service local exceptionpublic java.util.EnumSet<EffectiveRights> getEffectiveRights() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic java.lang.String getLastModifiedName() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic java.util.Date getLastModifiedTime() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic ConversationId getConversationId() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic 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 |