ISearchFacet.cs

using Newtonsoft.Json.Linq;

namespace Couchbase.Search
{
    /// <summary>
    /// A <see cref="ISearchFacet"/> allows for aggregating information collected on a particular result set.
    /// </summary>
    public interface ISearchFacet
    {
        /// <summary>
        /// The name of the facet.
        /// </summary>
        string Name { get; set; }

        /// <summary>
        /// The field of the facet.
        /// </summary>
        string Field { get; set; }

        /// <summary>
        /// The limit for ??????
        /// </summary>
        int Size { get; set; }

        /// <summary>
        /// Gets the JSON representation of this object.
        /// </summary>
        /// <returns></returns>
        JProperty ToJson();
    }

    #region [ License information ]

    /* ************************************************************
     *
     *    @author Couchbase <info@couchbase.com>
     *    @copyright 2014 Couchbase, Inc.
     *
     *    Licensed under the Apache License, Version 2.0 (the "License");
     *    you may not use this file except in compliance with the License.
     *    You may obtain a copy of the License at
     *
     *        http://www.apache.org/licenses/LICENSE-2.0
     *
     *    Unless required by applicable law or agreed to in writing, software
     *    distributed under the License is distributed on an "AS IS" BASIS,
     *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     *    See the License for the specific language governing permissions and
     *    limitations under the License.
     *
     * ************************************************************/

    #endregion
}