mcs/class/referencesource/System.Data.Entity/System/Data/Objects/ObjectResult.cs

   1 //---------------------------------------------------------------------
   2 // <copyright file="ObjectResult.cs" company="Microsoft">
   3 //      Copyright (c) Microsoft Corporation.  All rights reserved.
   4 // </copyright>
   5 //
   6 // @owner       Microsoft
   7 // @backupowner Microsoft
   8 //---------------------------------------------------------------------
   9
  10 namespace System.Data.Objects
  11 {
  12     using System;
  13     using System.Collections;
  14     using System.ComponentModel;
  15
  16     /// <summary>
  17     /// This class implements IEnumerable and IDisposable. Instance of this class
  18     /// is returned from ObjectQuery.Execute method.
  19     /// </summary>
  20     [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1710:IdentifiersShouldHaveCorrectSuffix")]
  21     public abstract class ObjectResult : IEnumerable, IDisposable, IListSource
  22     {
  23         internal ObjectResult()
  24         {
  25         }
  26
  27         IEnumerator IEnumerable.GetEnumerator()
  28         {
  29             return this.GetEnumeratorInternal();
  30         }
  31
  32         // ----------------------
  33         // IListSource  Properties
  34         // ----------------------
  35         /// <summary>
  36         ///   IListSource.ContainsListCollection implementation. Always returns false.
  37         /// </summary>
  38         bool IListSource.ContainsListCollection
  39         {
  40             get
  41             {
  42                 return false; // this means that the IList we return is the one which contains our actual data, it is not a collection
  43             }
  44         }
  45
  46         // ----------------------
  47         // IListSource  method
  48         // ----------------------
  49         /// <summary>
  50         ///   IListSource.GetList implementation
  51         /// </summary>
  52         /// <returns>
  53         ///   IList interface over the data to bind
  54         /// </returns>
  55         IList IListSource.GetList()
  56         {
  57             return this.GetIListSourceListInternal();
  58         }
  59
  60         public abstract Type ElementType
  61         {
  62             get;
  63         }
  64
  65         public abstract void Dispose();
  66
  67         /// <summary>
  68         ///   Get the next result set of a stored procedure.
  69         /// </summary>
  70         /// <returns>
  71         ///   An ObjectResult that enumerates the values of the next result set.   null, if there are no more, or if the
  72         ///   the ObjectResult is not the result of a stored procedure call.
  73         /// </returns>
  74         public ObjectResult<TElement> GetNextResult<TElement>()
  75         {
  76             return this.GetNextResultInternal<TElement>();
  77         }
  78
  79         internal abstract IEnumerator GetEnumeratorInternal();
  80         internal abstract IList GetIListSourceListInternal();
  81         internal abstract ObjectResult<TElement> GetNextResultInternal<TElement>();
  82     }
  83 }