microsoft.exchange.webservices.data
Class ResponseMessage

java.lang.Object
  extended by microsoft.exchange.webservices.data.ServiceObject
      extended by microsoft.exchange.webservices.data.ResponseObject<EmailMessage>
          extended by microsoft.exchange.webservices.data.ResponseMessage

public final class ResponseMessage
extends ResponseObject<EmailMessage>

The Class ResponseMessage.


Method Summary
 EmailAddressCollection getBccRecipients()
          * Gets a list of recipients the response will be sent to as Cc.
 MessageBody getBody()
          * Gets the body of the response.
 MessageBody getBodyPrefix()
          * Gets the body prefix of this response.
 EmailAddressCollection getCcRecipients()
          * Gets a list of recipients the response will be sent to as Cc.
protected  ExchangeVersion getMinimumRequiredServerVersion()
          Gets the minimum required server version.
 ResponseMessageType getResponseType()
          * Gets a value indicating the type of response this object represents.
protected  ServiceObjectSchema getSchema()
          Internal method to return the schema associated with this type of object.
 java.lang.String getSubject()
          * Gets the subject of this response.
 EmailAddressCollection getToRecipients()
          * Gets a list of recipients the response will be sent to.
protected  java.lang.String getXmlElementNameOverride()
          This methods lets subclasses of ServiceObject override the default mechanism by which the XML element name associated with their type is retrieved.
 void setBody(MessageBody value)
          Sets the body.
 void setBodyPrefix(MessageBody value)
          Sets the body prefix.
 void setSubject(java.lang.String value)
          Sets the subject.
 
Methods inherited from class microsoft.exchange.webservices.data.ResponseObject
internalCreate, internalDelete, internalLoad, save, save, save, send, sendAndSaveCopy, sendAndSaveCopy, sendAndSaveCopy
 
Methods inherited from class microsoft.exchange.webservices.data.ServiceObject
addServiceObjectChangedEvent, changed, clearChangeLog, clearServiceObjectChangedEvent, getChangeXmlElementName, getDeleteFieldXmlElementName, getExtendedProperties, getId, getIdPropertyDefinition, getIsCustomDateTimeScopingRequired, getIsTimeZoneHeaderRequired, getLoadedPropertyDefinitions, getObjectFromPropertyDefinition, getPropertyBag, getService, getSetFieldXmlElementName, getXmlElementName, isDirty, isNew, load, load, loadFromXml, loadFromXml, removeServiceObjectChangedEvent, schema, setService, throwIfThisIsNew, throwIfThisIsNotNew, tryGetExtendedProperty, tryGetProperty, tryGetProperty, validate, writeToXml, writeToXmlForUpdate
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getSchema

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

Overrides:
getSchema in class ResponseObject<EmailMessage>
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.

getXmlElementNameOverride

protected java.lang.String getXmlElementNameOverride()
This methods lets subclasses of ServiceObject override the default mechanism by which the XML element name associated with their type is retrieved.

Overrides:
getXmlElementNameOverride in class ServiceObject
Returns:
The XML element name associated with this type. If this method returns null or empty, the XML element name associated with this type is determined by the EwsObjectDefinition attribute that decorates the type,if present.

getResponseType

public ResponseMessageType getResponseType()
* Gets a value indicating the type of response this object represents.

Returns:
the response type

getBody

public MessageBody getBody()
                    throws java.lang.Exception
* Gets the body of the response.

Returns:
the body
Throws:
java.lang.Exception - the 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

getToRecipients

public EmailAddressCollection getToRecipients()
                                       throws java.lang.Exception
* Gets a list of recipients the response will be sent to.

Returns:
the to recipients
Throws:
java.lang.Exception - the exception

getCcRecipients

public EmailAddressCollection getCcRecipients()
                                       throws java.lang.Exception
* Gets a list of recipients the response will be sent to as Cc.

Returns:
the cc recipients
Throws:
java.lang.Exception - the exception

getBccRecipients

public EmailAddressCollection getBccRecipients()
                                        throws java.lang.Exception
* Gets a list of recipients the response will be sent to as Cc.

Returns:
the bcc recipients
Throws:
java.lang.Exception - the exception

getSubject

public java.lang.String getSubject()
                            throws java.lang.Exception
* Gets the subject of this response.

Returns:
the subject
Throws:
java.lang.Exception - the exception

setSubject

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

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

getBodyPrefix

public MessageBody getBodyPrefix()
                          throws java.lang.Exception
* Gets the body prefix of this response. The body prefix will be prepended to the original message's body when the response is created.

Returns:
the body prefix
Throws:
java.lang.Exception - the exception

setBodyPrefix

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

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