001/*
002 * The MIT License
003 * Copyright (c) 2012 Microsoft Corporation
004 *
005 * Permission is hereby granted, free of charge, to any person obtaining a copy
006 * of this software and associated documentation files (the "Software"), to deal
007 * in the Software without restriction, including without limitation the rights
008 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
009 * copies of the Software, and to permit persons to whom the Software is
010 * furnished to do so, subject to the following conditions:
011 *
012 * The above copyright notice and this permission notice shall be included in
013 * all copies or substantial portions of the Software.
014 *
015 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
016 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
017 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
018 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
019 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
020 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
021 * THE SOFTWARE.
022 */
023
024package microsoft.exchange.webservices.data.property.definition;
025
026import microsoft.exchange.webservices.data.core.EwsServiceXmlWriter;
027import microsoft.exchange.webservices.data.core.EwsUtilities;
028import microsoft.exchange.webservices.data.core.XmlAttributeNames;
029import microsoft.exchange.webservices.data.core.XmlElementNames;
030import microsoft.exchange.webservices.data.core.enumeration.misc.ExchangeVersion;
031import microsoft.exchange.webservices.data.core.exception.service.local.ServiceXmlSerializationException;
032
033/**
034 * Represents a property definition for a service object.
035 */
036public abstract class ServiceObjectPropertyDefinition extends
037    PropertyDefinitionBase {
038
039  /**
040   * The uri.
041   */
042  private String uri;
043
044  /**
045   * Gets the name of the XML element.
046   *
047   * @return the name of the XML element.
048   */
049  @Override
050  protected String getXmlElementName() {
051    return XmlElementNames.FieldURI;
052  }
053
054  /**
055   * Gets the minimum Exchange version that supports this property.
056   *
057   * @return The minimum Exchange version that supports this property.
058   */
059  @Override
060  public ExchangeVersion getVersion() {
061    return ExchangeVersion.Exchange2007_SP1;
062  }
063
064  /**
065   * Writes the attribute to XML.
066   *
067   * @param writer the writer
068   * @throws ServiceXmlSerializationException the service xml serialization exception
069   */
070  @Override
071  protected void writeAttributesToXml(EwsServiceXmlWriter writer)
072      throws ServiceXmlSerializationException {
073    writer.writeAttributeValue(XmlAttributeNames.FieldURI, this.getUri());
074  }
075
076  /**
077   * Initializes a new instance.
078   */
079  protected ServiceObjectPropertyDefinition() {
080    super();
081  }
082
083  /**
084   * Initializes a new instance.
085   *
086   * @param uri The URI.
087   */
088  protected ServiceObjectPropertyDefinition(String uri) {
089    this();
090    EwsUtilities.ewsAssert(!(uri == null || uri.isEmpty()), "ServiceObjectPropertyDefinition.ctor",
091                           "uri is null or empty");
092    this.uri = uri;
093  }
094
095  /**
096   * Gets the URI of the property definition.
097   *
098   * @return The URI of the property definition.
099   */
100  public String getUri() {
101    return uri;
102  }
103}