microsoft.exchange.webservices.data.ResolveNamesRequest 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="ResolveNamesRequest.java" company="Microsoft"
 *     Copyright (c) Microsoft Corporation.  All rights reserved.
 * 
 * Defines the ResolveNamesRequest class.
 **************************************************************************/
package microsoft.exchange.webservices.data;

import java.util.HashMap;
import java.util.Map;

/**
 * Represents a ResolveNames request.
 */
final class ResolveNamesRequest extends
MultiResponseServiceRequest {

	/** The Search scope map. */
	private static LazyMember> 
	searchScopeMap = 
		new LazyMember>(
				new ILazyMember>() {
					@Override
					public Map 
					createInstance() {

						Map map = 
							new HashMap();

						map.put(ResolveNameSearchLocation.DirectoryOnly,
						"ActiveDirectory");
						map.put(ResolveNameSearchLocation.DirectoryThenContacts,
						"ActiveDirectoryContacts");
						map.put(ResolveNameSearchLocation.ContactsOnly, 
								"Contacts");
						map.put(ResolveNameSearchLocation.ContactsThenDirectory,
						"ContactsActiveDirectory");

						return map;
					}

				});

	/** The name to resolve. */
	private String nameToResolve;

	/** The return full contact data. */
	private boolean returnFullContactData;

	/** The search location. */
	private ResolveNameSearchLocation searchLocation;

	/** The parent folder ids. */
	private FolderIdWrapperList parentFolderIds = new FolderIdWrapperList();

	/**
	 * Asserts the valid.
	 * 
	 * @throws Exception
	 *             the exception
	 */
	@Override
	protected void validate() throws Exception {
		super.validate();
		EwsUtilities.validateNonBlankStringParam(this.
				getNameToResolve(), "NameToResolve");
	}

	/**
	 * Creates the service response.
	 * 
	 * @param service
	 *            the service
	 * @param responseIndex
	 *            the response index
	 * @return Service response
	 */
	@Override
	protected ResolveNamesResponse createServiceResponse(
			ExchangeService service, int responseIndex) {
		return new ResolveNamesResponse(service);
	}

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

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

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

	/**
	 * Initializes a new instance of the class.
	 * 
	 * @param service
	 *            the service
	 * @throws Exception 
	 */
	protected ResolveNamesRequest(ExchangeService service)
	throws Exception {
		super(service, ServiceErrorHandling.ThrowOnError);
	}

	/**
	 * Gets the expected response message count.
	 * 
	 * @return Number of expected response messages
	 */
	@Override
	protected int getExpectedResponseMessageCount() {
		return 1;
	}

	/**
	 * Writes the attributes to XML.
	 * 
	 * @param writer
	 *            the writer
	 * @throws ServiceXmlSerializationException
	 *             the service xml serialization exception
	 */
	@Override
	protected void writeAttributesToXml(EwsServiceXmlWriter writer)
	throws ServiceXmlSerializationException {
		writer.writeAttributeValue(XmlAttributeNames.ReturnFullContactData,
				this.returnFullContactData);

		String searchScope = null;
		if (searchScopeMap.getMember().containsKey(searchLocation)) {
			searchScope = searchScopeMap.getMember().get(searchLocation);
		}

		EwsUtilities
		.EwsAssert(
				(!(searchScope == null || searchScope.isEmpty())),
				"ResolveNameRequest.WriteAttributesToXml",
				"The specified search location cannot " +
		"be mapped to an EWS search scope.");

		if(!this.getService().getExchange2007CompatibilityMode())
		{
			writer.writeAttributeValue(XmlAttributeNames.
					SearchScope, searchScope);
		}
	}

	/**
	 * Writes the attributes to XML.
	 * 
	 * @param writer
	 *            the writer
	 * @throws Exception
	 *             the exception
	 */
	@Override
	protected void writeElementsToXml(EwsServiceXmlWriter writer)
	throws Exception {
		this.getParentFolderIds().writeToXml(writer, XmlNamespace.Messages,
				XmlElementNames.ParentFolderIds);

		writer.writeElementValue(XmlNamespace.Messages,
				XmlElementNames.UnresolvedEntry, this.getNameToResolve());
	}

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

	/**
	 * Gets the name to resolve. The name to resolve.
	 * 
	 * @return the name to resolve
	 */
	public String getNameToResolve() {
		return this.nameToResolve;
	}

	/**
	 * Sets the name to resolve.
	 * 
	 * @param nameToResolve
	 *            the new name to resolve
	 */
	public void setNameToResolve(String nameToResolve) {
		this.nameToResolve = nameToResolve;
	}

	/**
	 * Gets a value indicating whether to return full contact data or
	 * not.  true if should return full contact data; otherwise,
	 * false. 
	 * 
	 * @return the return full contact data
	 */
	public boolean getReturnFullContactData() {
		return this.returnFullContactData;
	}

	/**
	 * Sets the return full contact data.
	 * 
	 * @param returnFullContactData
	 *            the new return full contact data
	 */
	public void setReturnFullContactData(boolean returnFullContactData) {
		this.returnFullContactData = returnFullContactData;
	}

	/**
	 * Gets the search location. The search scope.
	 * 
	 * @return the search location
	 */
	public ResolveNameSearchLocation getSearchLocation() {
		return this.searchLocation;
	}

	/**
	 * Sets the search location.
	 * 
	 * @param searchLocation
	 *            the new search location
	 */
	public void setSearchLocation(ResolveNameSearchLocation searchLocation) {
		this.searchLocation = searchLocation;
	}

	/**
	 * Gets the parent folder ids. The parent folder ids.
	 * 
	 * @return the parent folder ids
	 */
	public FolderIdWrapperList getParentFolderIds() {
		return this.parentFolderIds;
	}

}