|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectmicrosoft.exchange.webservices.data.ServiceResponse
public class ServiceResponse
Represents the standard response to an Exchange Web Services operation.
Constructor Summary | |
---|---|
protected |
ServiceResponse()
* Initializes a new instance. |
protected |
ServiceResponse(microsoft.exchange.webservices.data.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. |
java.util.Map<java.lang.String,java.lang.String> |
getErrorDetails()
Gets error details associated with the response. |
java.lang.String |
getErrorMessage()
* Gets a detailed error message associated with the response. |
java.util.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(microsoft.exchange.webservices.data.EwsServiceXmlReader reader,
java.lang.String xmlElementName)
Loads extra error details from XML |
protected void |
loadFromXml(microsoft.exchange.webservices.data.EwsServiceXmlReader reader,
java.lang.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(microsoft.exchange.webservices.data.EwsServiceXmlReader reader)
* Parses the message XML. |
protected void |
readElementsFromXml(microsoft.exchange.webservices.data.EwsServiceXmlReader reader)
* Reads response elements from XML. |
protected void |
setErrorMessage(java.lang.String errorMessage)
Sets a detailed error message associated with the response. |
protected 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 |
---|
protected ServiceResponse()
protected ServiceResponse(microsoft.exchange.webservices.data.SoapFaultDetails soapFaultDetails)
soapFaultDetails
- The SOAP fault details.Method Detail |
---|
protected void loadFromXml(microsoft.exchange.webservices.data.EwsServiceXmlReader reader, java.lang.String xmlElementName) throws java.lang.Exception
reader
- the readerxmlElementName
- the xml element name
java.lang.Exception
- the exceptionprotected void parseMessageXml(microsoft.exchange.webservices.data.EwsServiceXmlReader reader) throws java.lang.Exception
reader
- The reader.
java.lang.Exception
- the exceptionprotected void loaded()
protected void mapErrorCodeToErrorMessage()
protected void readElementsFromXml(microsoft.exchange.webservices.data.EwsServiceXmlReader reader) throws ServiceXmlDeserializationException, javax.xml.stream.XMLStreamException, java.lang.InstantiationException, java.lang.IllegalAccessException, ServiceLocalException, java.lang.Exception
reader
- The reader.
ServiceXmlDeserializationException
- the service xml deserialization exception
javax.xml.stream.XMLStreamException
- the xML stream exception
java.lang.InstantiationException
- the instantiation exception
java.lang.IllegalAccessException
- the illegal access exception
ServiceLocalException
- the service local exception
java.lang.Exception
- the exceptionprotected boolean loadExtraErrorDetailsFromXml(microsoft.exchange.webservices.data.EwsServiceXmlReader reader, java.lang.String xmlElementName) throws java.lang.Exception
reader
- The reader.xmlElementName
- The current element name of the extra error details.
java.lang.Exception
protected void throwIfNecessary() throws ServiceResponseException
ServiceResponseException
- the service response exceptionprotected void internalThrowIfNecessary() throws ServiceResponseException
ServiceResponseException
- the service response exceptionprotected boolean getBatchProcessingStopped()
public ServiceResult getResult()
public ServiceError getErrorCode()
public java.lang.String getErrorMessage()
protected void setErrorMessage(java.lang.String errorMessage)
errorMessage
- The error message associated with the response.public java.util.Map<java.lang.String,java.lang.String> getErrorDetails()
public java.util.Collection<PropertyDefinitionBase> getErrorProperties()
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |