MonoRail/Castle.MonoRail.Framework/IParameterBinder.cs

   1 // Copyright 2004-2007 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.Reflection;
  18
  19         /// <summary>
  20         /// Implemented by attributes that wants to perform
  21         /// some conversion to populate a smart dispatcher
  22         /// action argument.
  23         /// <seealso cref="DataBindAttribute"/>
  24         /// </summary>
  25         public interface IParameterBinder
  26         {
  27                 /// <summary>
  28                 /// Calculates the param points. Implementors should return value equals or greater than
  29                 /// zero indicating whether the parameter can be bound successfully. The greater the value (points)
  30                 /// the more successful the implementation indicates to the framework
  31                 /// </summary>
  32                 /// <param name="controller">The controller.</param>
  33                 /// <param name="parameterInfo">The parameter info.</param>
  34                 /// <returns></returns>
  35                 int CalculateParamPoints(SmartDispatcherController controller, ParameterInfo parameterInfo);
  36
  37                 /// <summary>
  38                 /// Binds the specified parameters for the action.
  39                 /// </summary>
  40                 /// <param name="controller">The controller.</param>
  41                 /// <param name="parameterInfo">The parameter info.</param>
  42                 /// <returns></returns>
  43                 object Bind(SmartDispatcherController controller, ParameterInfo parameterInfo);
  44         }
  45 }