MonoRail/Castle.MonoRail.Framework/IWizardStepPage.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         /// <summary>
  18         /// Pendent
  19         /// </summary>
  20         public interface IWizardStepPage : IController
  21         {
  22                 /// <summary>
  23                 /// Allow the step to assert some condition
  24                 /// before being accessed. Returning <c>false</c>
  25                 /// prevents the step from being processed but
  26                 /// before doing that you must send a redirect.
  27                 /// </summary>
  28                 /// <param name="context">The context.</param>
  29                 /// <returns>
  30                 ///     <c>true</c> if [is pre condition satisfied] [the specified context]; otherwise, <c>false</c>.
  31                 /// </returns>
  32                 bool IsPreConditionSatisfied(IEngineContext context);
  33
  34                 /// <summary>
  35                 /// Resets this instance.
  36                 /// </summary>
  37                 void Reset();
  38
  39                 /// <summary>
  40                 /// Gets the name of the step.
  41                 /// </summary>
  42                 /// <value>The name of the step.</value>
  43                 string ActionName { get; }
  44
  45                 /// <summary>
  46                 /// Gets the wizard controller (parent).
  47                 /// </summary>
  48                 /// <value>The wizard controller.</value>
  49                 IWizardController WizardController { get; set; }
  50
  51                 /// <summary>
  52                 /// Gets the controller context.
  53                 /// </summary>
  54                 /// <value>The controller context.</value>
  55                 IControllerContext WizardControllerContext { get; set; }
  56         }
  57 }