ActiveRecord/Castle.ActiveRecord/Framework/Config/IConfigurationSource.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
  16 {
  17         using System;
  18         using Castle.Core.Configuration;
  19
  20         /// <summary>
  21         /// Abstracts the source of configuration for the framework.
  22         /// </summary>
  23         public interface IConfigurationSource
  24         {
  25                 /// <summary>
  26                 /// Implementors should return the type that implements
  27                 /// the interface <see cref="IThreadScopeInfo"/>
  28                 /// </summary>
  29                 Type ThreadScopeInfoImplementation { get; }
  30
  31                 /// <summary>
  32                 /// Implementors should return the type that implements
  33                 /// the interface <see cref="ISessionFactoryHolder"/>
  34                 /// </summary>
  35                 Type SessionFactoryHolderImplementation { get; }
  36
  37                 /// <summary>
  38                 /// Implementors should return the type that implements
  39                 /// the interface NHibernate.Cfg.INamingStrategy
  40                 /// </summary>
  41                 Type NamingStrategyImplementation { get; }
  42
  43                 /// <summary>
  44                 /// Implementors should return an <see cref="IConfiguration"/>
  45                 /// instance
  46                 /// </summary>
  47                 /// <param name="type"></param>
  48                 /// <returns></returns>
  49                 IConfiguration GetConfiguration(Type type);
  50
  51                 /// <summary>
  52                 /// Gets a value indicating whether this <see cref="IConfigurationSource"/> produce debug information
  53                 /// </summary>
  54                 /// <value><c>true</c> if debug; otherwise, <c>false</c>.</value>
  55                 bool Debug { get; }
  56
  57                 /// <summary>
  58                 /// Gets a value indicating whether the entities should be lazy by default.
  59                 /// </summary>
  60                 /// <value>
  61                 ///     <c>true</c> if entities should be lazy by default; otherwise, <c>false</c>.
  62                 /// </value>
  63                 bool IsLazyByDefault { get; }
  64
  65                 /// <summary>
  66                 /// Gets a value indicating whether table names are assumed plural by default.
  67                 /// </summary>
  68                 /// <value>
  69                 ///     <c>true</c> if table names should be pluralized by default; otherwise, <c>false</c>.
  70                 /// </value>
  71                 bool PluralizeTableNames { get; }
  72
  73                 /// <summary>
  74                 /// Gets or sets a value indicating whether the models should be verified against the db schema on Initialisation.
  75                 /// </summary>
  76                 /// <value>
  77                 ///     <c>true</c> if models should be verified; otherwise, <c>false</c>.
  78                 /// </value>
  79                 bool VerifyModelsAgainstDBSchema { get; }
  80
  81         }
  82 }