ActiveRecord/Castle.ActiveRecord/Framework/Internal/IModelBuilderExtension.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.ActiveRecord.Framework.Internal
  16 {
  17         using System;
  18         using System.Reflection;
  19
  20         /// <summary>
  21         /// Gives a chance to external frameworks to plug into
  22         /// the AR model builder process. Particularly useful to
  23         /// inspect attributes and conventions outside the AR domain.
  24         /// </summary>
  25         public interface IModelBuilderExtension
  26         {
  27                 /// <summary>
  28                 /// Gives implementors a chance to process the class.
  29                 /// </summary>
  30                 /// <param name="type">The type.</param>
  31                 /// <param name="model">The model.</param>
  32                 void ProcessClass(Type type, ActiveRecordModel model);
  33
  34                 /// <summary>
  35                 /// Gives implementors a chance to process the property.
  36                 /// </summary>
  37                 /// <param name="pi">The property info reflection object.</param>
  38                 /// <param name="model">The model.</param>
  39                 void ProcessProperty(PropertyInfo pi, ActiveRecordModel model);
  40
  41                 /// <summary>
  42                 /// Gives implementors a chance to process the field.
  43                 /// </summary>
  44                 /// <param name="fi">The field info reflection object.</param>
  45                 /// <param name="model">The model.</param>
  46                 void ProcessField(FieldInfo fi, ActiveRecordModel model);
  47
  48                 /// <summary>
  49                 /// Gives implementors a chance to process the BelongsTo.
  50                 /// </summary>
  51                 /// <param name="pi">The property info reflection object.</param>
  52                 /// <param name="belongsToModel">The belongs to model.</param>
  53                 /// <param name="model">The model.</param>
  54                 void ProcessBelongsTo(PropertyInfo pi, BelongsToModel belongsToModel, ActiveRecordModel model);
  55
  56                 /// <summary>
  57                 /// Gives implementors a chance to process the HasMany.
  58                 /// </summary>
  59                 /// <param name="pi">The property info reflection object.</param>
  60                 /// <param name="hasManyModel">The has many model.</param>
  61                 /// <param name="model">The model.</param>
  62                 void ProcessHasMany(PropertyInfo pi, HasManyModel hasManyModel, ActiveRecordModel model);
  63
  64                 /// <summary>
  65                 /// Gives implementors a chance to process the HasManyToAny.
  66                 /// </summary>
  67                 /// <param name="pi">The property info reflection object.</param>
  68                 /// <param name="hasManyModel">The has many model.</param>
  69                 /// <param name="model">The model.</param>
  70                 void ProcessHasManyToAny(PropertyInfo pi, HasManyToAnyModel hasManyModel, ActiveRecordModel model);
  71
  72                 /// <summary>
  73                 /// Gives implementors a chance to process the HasAndBelongsToMany.
  74                 /// </summary>
  75                 /// <param name="pi">The property info reflection object.</param>
  76                 /// <param name="hasAndBelongManyModel">The has and belong many model.</param>
  77                 /// <param name="model">The model.</param>
  78                 void ProcessHasAndBelongsToMany(PropertyInfo pi, HasAndBelongsToManyModel hasAndBelongManyModel, ActiveRecordModel model);
  79         }
  80 }