MonoRail/Castle.MonoRail.Framework/IExecutableAction.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;
  18         using Descriptors;
  19
  20         /// <summary>
  21         /// Pendent
  22         /// </summary>
  23         public interface IExecutableAction
  24         {
  25                 /// <summary>
  26                 /// Gets a value indicating whether no filter should run before execute the action.
  27                 /// </summary>
  28                 /// <value>
  29                 ///     <c>true</c> if they should be skipped; otherwise, <c>false</c>.
  30                 /// </value>
  31                 bool ShouldSkipAllFilters { get; }
  32
  33                 /// <summary>
  34                 /// Pendent
  35                 /// </summary>
  36                 /// <param name="filterType">Type of the filter.</param>
  37                 /// <returns></returns>
  38                 bool ShouldSkipFilter(Type filterType);
  39
  40                 /// <summary>
  41                 /// Gets the layout override.
  42                 /// </summary>
  43                 /// <value>The layout override.</value>
  44                 string[] LayoutOverride { get; }
  45
  46                 /// <summary>
  47                 /// Gets the http method that the action requires before being executed.
  48                 /// </summary>
  49                 /// <value>The accessible through verb.</value>
  50                 Verb AccessibleThroughVerb { get; }
  51
  52                 /// <summary>
  53                 /// Indicates that no rescues whatsoever should be applied to this action.
  54                 /// </summary>
  55                 /// <returns></returns>
  56                 bool ShouldSkipRescues { get; }
  57
  58                 /// <summary>
  59                 /// Gets a rescue descriptor for the exception type.
  60                 /// </summary>
  61                 /// <param name="exceptionType">Type of the exception.</param>
  62                 /// <returns></returns>
  63                 RescueDescriptor GetRescueFor(Type exceptionType);
  64
  65                 /// <summary>
  66                 /// Gets the i18n related resource descriptors.
  67                 /// </summary>
  68                 /// <value>The resources.</value>
  69                 ResourceDescriptor[] Resources { get; }
  70
  71                 /// <summary>
  72                 /// Gets the cache policy configurer.
  73                 /// </summary>
  74                 /// <value>The cache policy configurer.</value>
  75                 ICachePolicyConfigurer CachePolicyConfigurer { get; }
  76
  77                 /// <summary>
  78                 /// Gets the return binder descriptor.
  79                 /// </summary>
  80                 /// <value>The return binder descriptor.</value>
  81                 ReturnBinderDescriptor ReturnBinderDescriptor { get; }
  82
  83                 /// <summary>
  84                 /// Executes the action this instance represents.
  85                 /// </summary>
  86                 /// <param name="engineContext">The engine context.</param>
  87                 /// <param name="controller">The controller.</param>
  88                 /// <param name="context">The context.</param>
  89                 object Execute(IEngineContext engineContext, IController controller, IControllerContext context);
  90         }
  91 }