Package microsoft.exchange.webservices.data.core.request

Class UpdateInboxRulesRequest

java.lang.Object

microsoft.exchange.webservices.data.core.request.ServiceRequestBase<T>

microsoft.exchange.webservices.data.core.request.SimpleServiceRequestBase<UpdateInboxRulesResponse>

microsoft.exchange.webservices.data.core.request.UpdateInboxRulesRequest

public final class UpdateInboxRulesRequest
extends SimpleServiceRequestBase<UpdateInboxRulesResponse>

Represents a UpdateInboxRulesRequest request.

Constructor Summary

Constructors

Constructor	Description
UpdateInboxRulesRequest(ExchangeService service)	Initializes a new instance of the UpdateInboxRulesRequest class.

Method Summary

Modifier and Type	Method	Description
UpdateInboxRulesResponse	execute()	Executes this request.
protected Iterable<RuleOperation>	getInboxRuleOperations()	Gets the RuleOperation collection.
protected String	getMailboxSmtpAddress()	Gets the address of the mailbox in which to update the inbox rules.
protected ExchangeVersion	getMinimumRequiredServerVersion()	Gets the request version.
protected boolean	getRemoveOutlookRuleBlob()	Gets a value indicating whether or not to remove OutlookRuleBlob from the rule collection.
protected String	getResponseXmlElementName()	Gets the name of the response XML element.
String	getXmlElementName()	Gets the name of the XML element.
protected UpdateInboxRulesResponse	parseResponse(EwsServiceXmlReader reader)	Parses the response.
void	setInboxRuleOperations(Iterable<RuleOperation> value)	Sets the RuleOperation collection.
void	setMailboxSmtpAddress(String value)	Sets the address of the mailbox in which to update the inbox rules.
void	setRemoveOutlookRuleBlob(boolean value)	Sets a value indicating whether or not to remove OutlookRuleBlob from the rule collection.
protected void	validate()	Validate request.
protected void	writeElementsToXml(EwsServiceXmlWriter writer)	Writes XML elements.

Methods inherited from class microsoft.exchange.webservices.data.core.request.SimpleServiceRequestBase

beginExecute, endInternalExecute, internalExecute

Methods inherited from class microsoft.exchange.webservices.data.core.request.ServiceRequestBase

buildEwsHttpPoolingWebRequest, buildEwsHttpWebRequest, getEwsHttpWebResponse, getResponseStream, getService, processWebException, readPreamble, readResponse, readResponse, readSoapFault, throwIfNotSupportedByRequestedServerVersion, traceResponse, validateAndEmitRequest, writeAttributesToXml, writeBodyToXml, writeToXml

Methods inherited from class java.lang.Object

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

Constructor Detail

UpdateInboxRulesRequest

public UpdateInboxRulesRequest(ExchangeService service)
                        throws Exception

Initializes a new instance of the UpdateInboxRulesRequest class.

Parameters:

service - The service.

Throws:

Exception

Method Detail

getXmlElementName

public String getXmlElementName()

Gets the name of the XML element.

Specified by:

getXmlElementName in class ServiceRequestBase<UpdateInboxRulesResponse>

Returns:

XML element name.

writeElementsToXml

protected void writeElementsToXml(EwsServiceXmlWriter writer)
                           throws Exception

Writes XML elements.

Specified by:

writeElementsToXml in class ServiceRequestBase<UpdateInboxRulesResponse>

Parameters:

writer - The writer.

Throws:

Exception - the exception

getResponseXmlElementName

protected String getResponseXmlElementName()

Gets the name of the response XML element.

Specified by:

getResponseXmlElementName in class ServiceRequestBase<UpdateInboxRulesResponse>

Returns:

XML element name.

parseResponse

protected UpdateInboxRulesResponse parseResponse(EwsServiceXmlReader reader)
                                          throws Exception

Parses the response.

Specified by:

parseResponse in class ServiceRequestBase<UpdateInboxRulesResponse>

Parameters:

reader - The reader.

Returns:

the Response Object.

Throws:

Exception - the exception

getMinimumRequiredServerVersion

protected ExchangeVersion getMinimumRequiredServerVersion()

Gets the request version.

Specified by:

getMinimumRequiredServerVersion in class ServiceRequestBase<UpdateInboxRulesResponse>

Returns:

Earliest Exchange version in which this request is supported.

validate

protected void validate()
                 throws Exception

Validate request.

Overrides:

validate in class ServiceRequestBase<UpdateInboxRulesResponse>

Throws:

ServiceLocalException - the service local exception

Exception - the exception

execute

public UpdateInboxRulesResponse execute()
                                 throws Exception

Executes this request.

Returns:

Service response.

Throws:

Exception - on error

getMailboxSmtpAddress

protected String getMailboxSmtpAddress()

Gets the address of the mailbox in which to update the inbox rules.

setMailboxSmtpAddress

public void setMailboxSmtpAddress(String value)

Sets the address of the mailbox in which to update the inbox rules.

getRemoveOutlookRuleBlob

protected boolean getRemoveOutlookRuleBlob()

Gets a value indicating whether or not to remove OutlookRuleBlob from the rule collection.

setRemoveOutlookRuleBlob

public void setRemoveOutlookRuleBlob(boolean value)

Sets a value indicating whether or not to remove OutlookRuleBlob from the rule collection.

getInboxRuleOperations

protected Iterable<RuleOperation> getInboxRuleOperations()

Gets the RuleOperation collection.

setInboxRuleOperations

public void setInboxRuleOperations(Iterable<RuleOperation> value)

Sets the RuleOperation collection.