ActiveRecord/Castle.ActiveRecord/Framework/Queries/IActiveRecordQuery.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
  16 {
  17         using System;
  18         using System.Collections;
  19
  20         using NHibernate;
  21
  22         /// <summary>
  23         /// Represents an ActiveRecord Query.
  24         /// </summary>
  25         public interface IActiveRecordQuery
  26         {
  27                 /// <summary>
  28                 /// Gets the target type of this query
  29                 /// </summary>
  30                 Type RootType { get; }
  31
  32                 /// <summary>
  33                 /// Executes the specified query and return the results
  34                 /// </summary>
  35                 /// <param name="session">The session to execute the query in.</param>
  36                 /// <returns></returns>
  37                 object Execute(ISession session);
  38
  39                 /// <summary>
  40                 /// Enumerates over the result of the query.
  41                 /// Note: Only use if you expect most of your values to already exist in the second level cache!
  42                 /// </summary>
  43                 IEnumerable Enumerate(ISession session);
  44         }
  45 }