MonoRail/Castle.MonoRail.Framework/ViewComponents/IViewComponentCacheKeyGenerator.cs

   1 // Copyright 2004-2008 Castle Project - http://www.castleproject.org/
   2 //
   3 // Licensed under the Apache License, Version 2.0 (the "License");
   4 // you may not use this file except in compliance with the License.
   5 // You may obtain a copy of the License at
   6 //
   7 //     http://www.apache.org/licenses/LICENSE-2.0
   8 //
   9 // Unless required by applicable law or agreed to in writing, software
  10 // distributed under the License is distributed on an "AS IS" BASIS,
  11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12 // See the License for the specific language governing permissions and
  13 // limitations under the License.
  14
  15 namespace Castle.MonoRail.Framework
  16 {
  17         using System.Collections;
  18
  19         /// <summary>
  20         /// Contract for implementation of cache key generators.
  21         /// </summary>
  22         ///
  23         /// <remarks>
  24         /// Implementors should use the parameters to the method <see cref="Create"/>
  25         /// to return an immutable representation of a cache key.
  26         /// </remarks>
  27         public interface IViewComponentCacheKeyGenerator
  28         {
  29                 /// <summary>
  30                 /// Creates a cache key that uniquely relates to the parameters specified.
  31                 /// </summary>
  32                 /// <param name="viewComponentName">Name of the view component.</param>
  33                 /// <param name="parameters">The parameters.</param>
  34                 /// <param name="context">The context.</param>
  35                 /// <returns></returns>
  36                 CacheKey Create(string viewComponentName, IDictionary parameters, IEngineContext context);
  37         }
  38 }