microsoft.exchange.webservices.data.GetInboxRulesRequest Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of exchange-ws-api Show documentation
The source came from http://archive.msdn.microsoft.com/ewsjavaapi Support for Maven has been added.
The newest version!
/**************************************************************************
 * copyright file="GetInboxRulesRequest.java" company="Microsoft"
 *     Copyright (c) Microsoft Corporation.  All rights reserved.
 * 
 * Defines the GetInboxRulesRequest.java.
 **************************************************************************/
package microsoft.exchange.webservices.data;

import javax.xml.stream.XMLStreamException;

/***
 * Represents a GetInboxRules request.
 */
final class GetInboxRulesRequest extends SimpleServiceRequestBase{

	/***
	 * The smtp address of the mailbox from which to get the inbox rules.
	 */
	private String mailboxSmtpAddress;

	/***
	 * Initializes a new instance of the GetInboxRulesRequest class.
	 * @param service The service.
	 * @throws Exception 
	 */
	protected GetInboxRulesRequest(ExchangeService service) throws Exception {
		super(service);
	}

	/***
	 * Gets or sets the address of the mailbox
	 *  from which to get the inbox rules.
	 * @return the mailboxSmtpAddress
	 */
	protected String getmailboxSmtpAddress() {
		return this.mailboxSmtpAddress;
	}

	/***
	 *  sets the address of the mailbox from which to get the inbox rules.
	 */
	protected void setmailboxSmtpAddress(String value) {
		this.mailboxSmtpAddress = value; 
	}

	/***
	 * Gets the name of the XML element.
	 * @return XML element name.
	 */
	@Override
	protected String getXmlElementName() {
		return XmlElementNames.GetInboxRules;
	}

	/***
	 * Writes XML elements.
	 * @param writer The writer.
	 * @throws XMLStreamException 
	 * @throws ServiceXmlSerializationException 
	 */
	@Override
	protected void writeElementsToXml(EwsServiceXmlWriter writer) 
	throws ServiceXmlSerializationException, XMLStreamException {
		if (!(this.mailboxSmtpAddress == null ||
				this.mailboxSmtpAddress.isEmpty())) {
			writer.writeElementValue(
					XmlNamespace.Messages, 
					XmlElementNames.MailboxSmtpAddress, 
					this.mailboxSmtpAddress);
		}
	}

	/***
	 * Gets the name of the response XML element.
	 * @return XML element name.
	 */
	@Override
	protected String getResponseXmlElementName() {
		return XmlElementNames.GetInboxRulesResponse;
	}

	/***
	 * Parses the response.
	 * @param reader The reader.
	 * @return Response object.
	 * @throws Exception 
	 */
	@Override
	protected Object parseResponse(EwsServiceXmlReader reader)
	throws Exception {
		GetInboxRulesResponse response = new GetInboxRulesResponse();
		response.loadFromXml(reader, XmlElementNames.GetInboxRulesResponse);
		return response;
	}

	/***
	 * Gets the request version.
	 * @return Earliest Exchange version in which this request is supported.
	 */
	@Override
	protected ExchangeVersion getMinimumRequiredServerVersion() {
		return ExchangeVersion.Exchange2010_SP1;
	}

	/***
	 * Executes this request.
	 * @return Service response.
	 * @throws Exception 
	 * @throws ServiceLocalException 
	 */
	protected GetInboxRulesResponse execute() 
	throws ServiceLocalException, Exception {
		GetInboxRulesResponse serviceResponse =
			(GetInboxRulesResponse)this.internalExecute();
		serviceResponse.throwIfNecessary();
		return serviceResponse;
	}
}