Orchard/src/Orchard.Web/Core/Common/Services/IRoutableService.cs

using System;
using System.Collections.Generic;
using Orchard.Core.Common.Models;

namespace Orchard.Core.Common.Services {
    public interface IRoutableService : IDependency {
        void FillSlug<TModel>(TModel model) where TModel : RoutableAspect;
        void FillSlug<TModel>(TModel model, Func<string, string> generateSlug) where TModel : RoutableAspect;
        string GenerateUniqueSlug(string slugCandidate, IEnumerable<string> existingSlugs);

        /// <summary>
        /// Returns any content item of the specified content type with similar slugs
        /// </summary>
        IEnumerable<RoutableAspect> GetSimilarSlugs(string contentType, string slug);

        /// <summary>
        /// Validates the given slug
        /// </summary>
        bool IsSlugValid(string slug);

        /// <summary>
        /// Defines the slug of a RoutableAspect and validate its unicity
        /// </summary>
        /// <returns>True if the slug has been created, False if a conflict occured</returns>
        bool ProcessSlug(RoutableAspect part);

    }
}