74 lines
3.4 KiB
C#
74 lines
3.4 KiB
C#
using System;
|
|
using System.Collections.Generic;
|
|
using System.Linq;
|
|
using System.Text;
|
|
using System.Xml.XPath;
|
|
using Umbraco.Core.CodeAnnotations;
|
|
using Umbraco.Core.Models;
|
|
using Umbraco.Core.Xml;
|
|
|
|
namespace Umbraco.Web.PublishedCache
|
|
{
|
|
/// <summary>
|
|
/// Provides access to cached contents.
|
|
/// </summary>
|
|
[UmbracoExperimentalFeature("http://issues.umbraco.org/issue/U4-1153",
|
|
"We need to create something like the IPublishListener interface to have proper published content storage.")]
|
|
public interface IPublishedCache
|
|
{
|
|
/// <summary>
|
|
/// Gets a content identified by its unique identifier.
|
|
/// </summary>
|
|
/// <param name="umbracoContext">The context.</param>
|
|
/// <param name="contentId">The content unique identifier.</param>
|
|
/// <returns>The content, or null.</returns>
|
|
IPublishedContent GetById(UmbracoContext umbracoContext, int contentId);
|
|
|
|
/// <summary>
|
|
/// Gets contents at root.
|
|
/// </summary>
|
|
/// <param name="umbracoContext">The context.</param>
|
|
/// <returns>The contents.</returns>
|
|
IEnumerable<IPublishedContent> GetAtRoot(UmbracoContext umbracoContext);
|
|
|
|
/// <summary>
|
|
/// Gets a content resulting from an XPath query.
|
|
/// </summary>
|
|
/// <param name="umbracoContext">The context.</param>
|
|
/// <param name="xpath">The XPath query.</param>
|
|
/// <param name="vars">Optional XPath variables.</param>
|
|
/// <returns>The content, or null.</returns>
|
|
IPublishedContent GetSingleByXPath(UmbracoContext umbracoContext, string xpath, XPathVariable[] vars);
|
|
|
|
/// <summary>
|
|
/// Gets contents resulting from an XPath query.
|
|
/// </summary>
|
|
/// <param name="umbracoContext">The context.</param>
|
|
/// <param name="xpath">The XPath query.</param>
|
|
/// <param name="vars">Optional XPath variables.</param>
|
|
/// <returns>The contents.</returns>
|
|
IEnumerable<IPublishedContent> GetByXPath(UmbracoContext umbracoContext, string xpath, XPathVariable[] vars);
|
|
|
|
/// <summary>
|
|
/// Gets an XPath navigator that can be used to navigate contents.
|
|
/// </summary>
|
|
/// <param name="umbracoContext">The context.</param>
|
|
/// <returns>The XPath navigator.</returns>
|
|
XPathNavigator GetXPathNavigator(UmbracoContext umbracoContext);
|
|
|
|
/// <summary>
|
|
/// Gets a value indicating whether the cache contains published content.
|
|
/// </summary>
|
|
/// <returns>A value indicating whether the cache contains published content.</returns>
|
|
bool HasContent();
|
|
|
|
//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);
|
|
}
|
|
}
|