Umbraco-CMS/src/Umbraco.Web/IPublishedContentQuery.cs

using System;
using System.Collections.Generic;
using System.Xml.XPath;
using Examine.Search;
using Umbraco.Core;
using Umbraco.Core.Models.PublishedContent;
using Umbraco.Core.Xml;

namespace Umbraco.Web
{
    using Examine = global::Examine;

    /// <summary>
    /// Query methods used for accessing strongly typed content in templates
    /// </summary>
    public interface IPublishedContentQuery
    {
        IPublishedContent Content(int id);
        IPublishedContent Content(Guid id);
        IPublishedContent Content(Udi id);
        IPublishedContent ContentSingleAtXPath(string xpath, params XPathVariable[] vars);
        IEnumerable<IPublishedContent> Content(IEnumerable<int> ids);
        IEnumerable<IPublishedContent> Content(IEnumerable<Guid> ids);
        IEnumerable<IPublishedContent> ContentAtXPath(string xpath, params XPathVariable[] vars);
        IEnumerable<IPublishedContent> ContentAtXPath(XPathExpression xpath, params XPathVariable[] vars);
        IEnumerable<IPublishedContent> ContentAtRoot();

        IPublishedContent Media(int id);
        IPublishedContent Media(Guid id);
        IPublishedContent Media(Udi id);
        IEnumerable<IPublishedContent> Media(IEnumerable<int> ids);
        IEnumerable<IPublishedContent> Media(IEnumerable<Guid> ids);
        IEnumerable<IPublishedContent> MediaAtRoot();

        /// <summary>
        /// Searches content.
        /// </summary>
        /// <param name="term">Term to search.</param>
        /// <param name="culture">Optional culture.</param>
        /// <param name="indexName">Optional index name.</param>
        /// <remarks>
        /// <para>
        /// When the <paramref name="culture"/> is not specified or is *, all cultures are searched.
        /// To search for only invariant documents and fields use null.
        /// When searching on a specific culture, all culture specific fields are searched for the provided culture and all invariant fields for all documents.
        /// </para>
        /// <para>While enumerating results, the ambient culture is changed to be the searched culture.</para>
        /// </remarks>
        IEnumerable<PublishedSearchResult> Search(string term, string culture = "*", string indexName = null);

        /// <summary>
        /// Searches content.
        /// </summary>
        /// <param name="term">Term to search.</param>
        /// <param name="skip">Numbers of items to skip.</param>
        /// <param name="take">Numbers of items to return.</param>
        /// <param name="totalRecords">Total number of matching items.</param>
        /// <param name="culture">Optional culture.</param>
        /// <param name="indexName">Optional index name.</param>
        /// <remarks>
        /// <para>
        /// When the <paramref name="culture"/> is not specified or is *, all cultures are searched.
        /// To search for only invariant documents and fields use null.
        /// When searching on a specific culture, all culture specific fields are searched for the provided culture and all invariant fields for all documents.
        /// </para>
        /// <para>While enumerating results, the ambient culture is changed to be the searched culture.</para>
        /// </remarks>
        IEnumerable<PublishedSearchResult> Search(string term, int skip, int take, out long totalRecords, string culture = "*", string indexName = null);

        /// <summary>
        /// Executes the query and converts the results to PublishedSearchResult.
        /// </summary>
        /// <remarks>
        /// <para>While enumerating results, the ambient culture is changed to be the searched culture.</para>
        /// </remarks>
        IEnumerable<PublishedSearchResult> Search(IQueryExecutor query);

        /// <summary>
        /// Executes the query and converts the results to PublishedSearchResult.
        /// </summary>
        /// <remarks>
        /// <para>While enumerating results, the ambient culture is changed to be the searched culture.</para>
        /// </remarks>
        IEnumerable<PublishedSearchResult> Search(IQueryExecutor query, int skip, int take, out long totalRecords);
    }
}