microsoft.exchange.webservices.data.core.response
Class ServiceResponse

java.lang.Object
  microsoft.exchange.webservices.data.core.response.ServiceResponse

Direct Known Subclasses:

AttendeeAvailability, ConvertIdResponse, CreateAttachmentResponse, CreateFolderResponse, CreateItemResponse, CreateResponseObjectResponse, DelegateManagementResponse, DelegateUserResponse, DeleteAttachmentResponse, ExecuteDiagnosticMethodResponse, ExpandGroupResponse, FindConversationResponse, FindFolderResponse, FindItemResponse, GetAttachmentResponse, GetEventsResponse, GetFolderResponse, GetInboxRulesResponse, GetItemResponse, GetPasswordExpirationDateResponse, GetPhoneCallResponse, GetRoomListsResponse, GetRoomsResponse, GetServerTimeZonesResponse, GetStreamingEventsResponse, GetUserConfigurationResponse, GetUserOofSettingsResponse, MoveCopyFolderResponse, MoveCopyItemResponse, PlayOnPhoneResponse, ResolveNamesResponse, SubscribeResponse, SuggestionsResponse, SyncResponse, UpdateFolderResponse, UpdateInboxRulesResponse, UpdateItemResponse

public class ServiceResponse
extends Object

Represents the standard response to an Exchange Web Services operation.

Constructor Summary

ServiceResponse()
Initializes a new instance.

ServiceResponse(SoapFaultDetails soapFaultDetails)
Initializes a new instance.

Method Summary

protected boolean	getBatchProcessingStopped() Gets a value indicating whether a batch request stopped processing before the end.
ServiceError	getErrorCode() Gets the error code associated with this response.
Map<String,String>	getErrorDetails() Gets error details associated with the response.
String	getErrorMessage() Gets a detailed error message associated with the response.
Collection<PropertyDefinitionBase>	getErrorProperties() Gets information about property errors associated with the response.
ServiceResult	getResult() Gets the result associated with this response.
protected void	internalThrowIfNecessary() Internal method that throws a ServiceResponseException if this response has its Result property set to Error.
protected void	loaded() Called when the response has been loaded from XML.
protected boolean	loadExtraErrorDetailsFromXml(EwsServiceXmlReader reader, String xmlElementName) Loads extra error details from XML
void	loadFromXml(EwsServiceXmlReader reader, String xmlElementName) Loads response from XML.
protected void	mapErrorCodeToErrorMessage() Called after the response has been loaded from XML in order to map error codes to "better" error messages.
protected void	parseMessageXml(EwsServiceXmlReader reader) Parses the message XML.
protected void	readElementsFromXml(EwsServiceXmlReader reader) Reads response elements from XML.
protected void	setErrorMessage(String errorMessage) Sets a detailed error message associated with the response.
void	throwIfNecessary() Throws a ServiceResponseException if this response has its Result property set to Error.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ServiceResponse

public ServiceResponse()

Initializes a new instance.

ServiceResponse

public ServiceResponse(SoapFaultDetails soapFaultDetails)

Initializes a new instance.

Parameters:

soapFaultDetails - The SOAP fault details.

Method Detail

loadFromXml

public void loadFromXml(EwsServiceXmlReader reader,
                        String xmlElementName)
                 throws Exception

Loads response from XML.

Parameters:

reader - the reader

xmlElementName - the xml element name

Throws:

Exception - the exception

parseMessageXml

protected void parseMessageXml(EwsServiceXmlReader reader)
                        throws Exception

Parses the message XML.

Parameters:

reader - The reader.

Throws:

Exception - the exception

loaded

protected void loaded()

Called when the response has been loaded from XML.

mapErrorCodeToErrorMessage

protected void mapErrorCodeToErrorMessage()

Called after the response has been loaded from XML in order to map error codes to "better" error messages.

readElementsFromXml

protected void readElementsFromXml(EwsServiceXmlReader reader)
                            throws Exception

Reads response elements from XML.

Parameters:

reader - the reader

Throws:

Exception - the exception

loadExtraErrorDetailsFromXml

protected boolean loadExtraErrorDetailsFromXml(EwsServiceXmlReader reader,
                                               String xmlElementName)
                                        throws Exception

Loads extra error details from XML

Parameters:

reader - The reader.

xmlElementName - The current element name of the extra error details.

Returns:

True if the expected extra details is loaded; False if the element name does not match the expected element.

Throws:

Exception

throwIfNecessary

public void throwIfNecessary()
                      throws ServiceResponseException

Throws a ServiceResponseException if this response has its Result property set to Error.

Throws:

ServiceResponseException - the service response exception

internalThrowIfNecessary

protected void internalThrowIfNecessary()
                                 throws ServiceResponseException

Internal method that throws a ServiceResponseException if this response has its Result property set to Error.

Throws:

ServiceResponseException - the service response exception

getBatchProcessingStopped

protected boolean getBatchProcessingStopped()

Gets a value indicating whether a batch request stopped processing before the end.

Returns:

A value indicating whether a batch request stopped processing before the end.

getResult

public ServiceResult getResult()

Gets the result associated with this response.

Returns:

The result associated with this response.

getErrorCode

public ServiceError getErrorCode()

Gets the error code associated with this response.

Returns:

The error code associated with this response.

getErrorMessage

public String getErrorMessage()

Gets a detailed error message associated with the response. If Result is set to Success, ErrorMessage returns null. ErrorMessage is localized according to the PreferredCulture property of the ExchangeService object that was used to call the method that generated the response.

Returns:

the error message

setErrorMessage

protected void setErrorMessage(String errorMessage)

Sets a detailed error message associated with the response.

Parameters:

errorMessage - The error message associated with the response.

getErrorDetails

public Map<String,String> getErrorDetails()

Gets error details associated with the response. If Result is set to Success, ErrorDetailsDictionary returns null. Error details will only available for some error codes. For example, when error code is ErrorRecurrenceHasNoOccurrence, the ErrorDetailsDictionary will contain keys for EffectiveStartDate and EffectiveEndDate.

Returns:

The error details dictionary.

getErrorProperties

public Collection<PropertyDefinitionBase> getErrorProperties()

Gets information about property errors associated with the response. If Result is set to Success, ErrorProperties returns null. ErrorProperties is only available for some error codes. For example, when the error code is ErrorInvalidPropertyForOperation, ErrorProperties will contain the definition of the property that was invalid for the request.

Returns:

the error property