using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;

using Umbraco.Core.CodeAnnotations;
using Umbraco.Core.Models;
using Umbraco.Core.Xml;

namespace Umbraco.Web.PublishedCache
{
	/// <summary>
	/// Defines the methods for published documents
	/// </summary>
	[UmbracoExperimentalFeature("http://issues.umbraco.org/issue/U4-1153",
        "We need to create something like the IPublishListener interface to have proper published content storage.")]
    internal interface IPublishedCache
    {
        // FIXME do we need the context here?!
        // FIXME write documentation

		IPublishedContent GetById(UmbracoContext umbracoContext, int nodeId);
		IEnumerable<IPublishedContent> GetAtRoot(UmbracoContext umbracoContext);

	    IPublishedContent GetSingleByXPath(UmbracoContext umbracoContext, string xpath, XPathVariable[] vars);
        IEnumerable<IPublishedContent> GetByXPath(UmbracoContext umbracoContext, string xpath, XPathVariable[] vars);

	    // ... GetXPath single or multi
	    // ... pass the helper and NOT the store, so we're consistent?!

	    //TODO: SD: We should make this happen! This will allow us to natively do a GetByDocumentType query
	    // on the UmbracoHelper (or an internal DataContext that it uses, etc...)
	    // One issue is that we need to make media work as fast as we can and need to create a ConvertFromMediaObject
	    // method in the DefaultPublishedMediaStore, there's already a TODO noting this but in order to do that we'll 
	    // have to also use Examine as much as we can so we don't have to make db calls for looking up things like the 
	    // node type alias, etc... in order to populate the created IPublishedContent object.
	    //IEnumerable<IPublishedContent> GetDocumentsByType(string docTypeAlias);
    }
}