ActiveRecord/Castle.ActiveRecord/Framework/IThreadScopeInfo.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.ActiveRecord.Framework
  16 {
  17         using System.Collections;
  18
  19         /// <summary>
  20         /// Implementation of this interface provide a way to get the current scope.
  21         /// This is used by the rest of the Active Record framework to grab a scope (and from it a session).
  22         /// </summary>
  23         public interface IThreadScopeInfo
  24         {
  25                 /// <summary>
  26                 /// Gets the current stack.
  27                 /// </summary>
  28                 /// <value>The current stack.</value>
  29                 Stack CurrentStack { get; }
  30
  31                 /// <summary>
  32                 /// Gets the registered scope.
  33                 /// </summary>
  34                 /// <returns></returns>
  35                 ISessionScope GetRegisteredScope();
  36
  37                 /// <summary>
  38                 /// Registers the scope.
  39                 /// </summary>
  40                 /// <param name="scope">The scope.</param>
  41                 void RegisterScope(ISessionScope scope);
  42
  43                 /// <summary>
  44                 /// Unregister the scope.
  45                 /// </summary>
  46                 /// <param name="scope">The scope.</param>
  47                 void UnRegisterScope(ISessionScope scope);
  48
  49                 /// <summary>
  50                 /// Gets a value indicating whether this instance has initialized scope.
  51                 /// </summary>
  52                 /// <value>
  53                 ///     <c>true</c> if this instance has initialized scope; otherwise, <c>false</c>.
  54                 /// </value>
  55                 bool HasInitializedScope { get; }
  56         }
  57 }