mcs/class/System.Data/System.Data.Common/DbCommand.cs

   1 //
   2 // System.Data.Common.DbCommand
   3 //
   4 // Author:
   5 //   Tim Coleman (tim@timcoleman.com)
   6 //
   7 // Copyright (C) Tim Coleman, 2003
   8 //
   9
  10 //
  11 // Copyright (C) 2004 Novell, Inc (http://www.novell.com)
  12 //
  13 // Permission is hereby granted, free of charge, to any person obtaining
  14 // a copy of this software and associated documentation files (the
  15 // "Software"), to deal in the Software without restriction, including
  16 // without limitation the rights to use, copy, modify, merge, publish,
  17 // distribute, sublicense, and/or sell copies of the Software, and to
  18 // permit persons to whom the Software is furnished to do so, subject to
  19 // the following conditions:
  20 //
  21 // The above copyright notice and this permission notice shall be
  22 // included in all copies or substantial portions of the Software.
  23 //
  24 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  25 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  26 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  27 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  28 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  29 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  30 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  31 //
  32
  33 #if NET_2_0 || TARGET_JVM
  34
  35 using System.ComponentModel;
  36 using System.Data;
  37
  38 namespace System.Data.Common {
  39         public abstract class DbCommand : Component, IDbCommand, IDisposable
  40         {
  41                 protected DbCommand ()
  42                 {
  43                 }
  44
  45                 #region Properties
  46
  47                 public abstract string CommandText { get; set; }
  48                 public abstract int CommandTimeout { get; set; }
  49                 public abstract CommandType CommandType { get; set; }
  50
  51                 public DbConnection Connection {
  52                         get { return DbConnection; }
  53                         set { DbConnection = value; }
  54                 }
  55
  56                 protected abstract DbConnection DbConnection { get; set; }
  57                 protected abstract DbParameterCollection DbParameterCollection { get; }
  58                 protected abstract DbTransaction DbTransaction { get; set; }
  59                 public abstract bool DesignTimeVisible { get; set; }
  60
  61                 IDbConnection IDbCommand.Connection {
  62                         get { return Connection; }
  63                         set { Connection = (DbConnection) value; }
  64                 }
  65
  66                 IDataParameterCollection IDbCommand.Parameters {
  67                         get { return Parameters; }
  68                 }
  69
  70                 IDbTransaction IDbCommand.Transaction {
  71                         get { return Transaction; }
  72                         set { Transaction = (DbTransaction) value; }
  73                 }
  74
  75 #if NET_2_0
  76                 [MonoTODO]
  77                 public virtual DbCommandOptionalFeatures OptionalFeatures {
  78                         get { throw new NotImplementedException (); }
  79                 }
  80 #endif
  81
  82                 public DbParameterCollection Parameters {
  83                         get { return DbParameterCollection; }
  84                 }
  85
  86                 public DbTransaction Transaction {
  87                         get { return DbTransaction; }
  88                         set { DbTransaction = value; }
  89                 }
  90
  91                 public abstract UpdateRowSource UpdatedRowSource { get; set; }
  92
  93                 #endregion // Properties
  94
  95                 #region Methods
  96
  97                 public abstract void Cancel ();
  98                 protected abstract DbParameter CreateDbParameter ();
  99
 100                 public DbParameter CreateParameter ()
 101                 {
 102                         return CreateDbParameter ();
 103                 }
 104
 105                 protected abstract DbDataReader ExecuteDbDataReader (CommandBehavior behavior);
 106
 107                 [MonoTODO]
 108                 protected virtual DbDataReader ExecuteDbPageReader (CommandBehavior behavior, int startRecord, int maxRecords)
 109                 {
 110                         throw new NotImplementedException ();
 111                 }
 112
 113                 public abstract int ExecuteNonQuery ();
 114
 115                 public DbDataReader ExecutePageReader (CommandBehavior behavior, int startRecord, int maxRecords)
 116                 {
 117                         return ExecuteDbPageReader (behavior, startRecord, maxRecords);
 118                 }
 119
 120                 public DbDataReader ExecuteReader ()
 121                 {
 122                         return ExecuteDbDataReader (CommandBehavior.Default);
 123                 }
 124
 125                 public DbDataReader ExecuteReader (CommandBehavior behavior)
 126                 {
 127                         return ExecuteDbDataReader (behavior);
 128                 }
 129
 130                 public abstract object ExecuteScalar ();
 131
 132                 IDbDataParameter IDbCommand.CreateParameter ()
 133                 {
 134                         return CreateParameter ();
 135                 }
 136
 137                 IDataReader IDbCommand.ExecuteReader ()
 138                 {
 139                         return ExecuteReader ();
 140                 }
 141
 142                 IDataReader IDbCommand.ExecuteReader (CommandBehavior behavior)
 143                 {
 144                         return ExecuteReader (behavior);
 145                 }
 146
 147                 public abstract void Prepare ();
 148
 149                 #endregion // Methods
 150
 151         }
 152 }
 153
 154 #endif