GeoNames .NET WCF Client

#region Header
/////////////////////////////////////////////////////////////////////////////
//
// Myren.GeoNames.Client.GeoPostalCodeSearchCriteria
//
//
// Authors: 
//   Dennis Myren
//   
//
/////////////////////////////////////////////////////////////////////////////
// 
// Copyright (c) 2008 Dennis Myren
// 
// Permission is hereby granted, free of charge, to any person obtaining
// a copy of this software and associated documentation files (the "Software"),
// to deal in the Software without restriction, including without limitation
// the rights to use, copy, modify, merge, publish, distribute, sublicense,
// and/or sell copies of the Software, and to permit persons to whom the
// Software is furnished to do so, subject to the following conditions:
// 
// The above copyright notice and this permission notice shall be included
// in all copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.
//
///////////////////////////////////////////////////////////////////////////////
#endregion // Header


using System;

using Myren.GeoNames.Client.Internal;


namespace Myren.GeoNames.Client
{

  /// <summary>
  /// Provides the criteria for a postal code search operation.
  /// </summary>
  public sealed class GeoPostalCodeSearchCriteria
  {

    /// <summary>
    /// Creates a new instance of GeoPostalCodeSearchCriteria.
    /// </summary>
    public GeoPostalCodeSearchCriteria ( )
    {
    }


    /// <summary>
    /// A postal code.
    /// </summary>
    public string PostalCode
    {
      get;
      set;
    }

    /// <summary>
    /// The first characters or letters of a postal code.
    /// </summary>
    public string PostalCodeStartsWith
    {
      get;
      set;
    }

    /// <summary>
    /// A place name.
    /// </summary>
    public string PlaceName
    {
      get;
      set;
    }

    /// <summary>
    /// The first characters of a place name.
    /// </summary>
    public string PlaceNameStartsWith
    {
      get;
      set;
    }

    /// <summary>
    /// A country. Default is all countries.
    /// </summary>
    public string Country
    {
      get;
      set;
    }

    /// <summary>
    /// Records from the countryBias are listed first.
    /// </summary>
    public string CountryBias
    {
      get;
      set;
    }

    /// <summary>
    /// The maximal number of rows in the document returned by the service. Default is 10.
    /// </summary>
    public int MaxRows
    {
      get
      {
        return _maxRows;
      }
      set
      {
        _maxRows = value;
      }
    }
    private int _maxRows = 10;

    /// <summary>
    /// Response verbosity; short, medium, long or full.
    /// </summary>
    public GeoStyle Style
    {
      get
      {
        return _style;
      }
      set
      {
        if ( !Enum.IsDefined ( typeof ( GeoStyle ), value ) )
          throw new ArgumentException ( SR.InvalidStyle, "value" );

        _style = value;
      }
    }
    private GeoStyle _style = GeoStyle.Full;


  }


}