Craig's Utility Library  4.0 Beta
Utilities.ORM.Manager.QueryProvider.BaseClasses.ParameterBase< DataType > Class Template Referenceabstract

Parameter base class More...

Inheritance diagram for Utilities.ORM.Manager.QueryProvider.BaseClasses.ParameterBase< DataType >:
Utilities.ORM.Manager.QueryProvider.Interfaces.IParameter< DataType > Utilities.ORM.Manager.QueryProvider.Default.Parameter< DataType > Utilities.ORM.Parameters.BetweenParameter< DataType > Utilities.ORM.Parameters.EqualParameter< DataType > Utilities.ORM.Parameters.NotEqualParameter< DataType >

Public Member Functions

abstract void AddParameter (DbCommand Helper)
 Adds this parameter to the SQLHelper More...
 
string AddParameter (string Command)
 Finds itself in the string command and adds the value More...
 
abstract IParameter CreateCopy (string Suffix)
 Creates a copy of the parameter More...
 
override bool Equals (object obj)
 Determines if the objects are equal More...
 
override int GetHashCode ()
 Gets the hash code for the object More...
 
override string ToString ()
 Returns the string version of the parameter More...
 
- Public Member Functions inherited from Utilities.ORM.Manager.QueryProvider.Interfaces.IParameter< DataType >
void AddParameter (DbCommand Helper)
 Adds this parameter to the SQLHelper More...
 
string AddParameter (string Command)
 Finds itself in the string command and adds the value More...
 
IParameter CreateCopy (string Suffix)
 Creates a copy of the parameter More...
 

Static Public Member Functions

static bool operator!= (ParameterBase< DataType > first, ParameterBase< DataType > second)
 != operator More...
 
static bool operator== (ParameterBase< DataType > first, ParameterBase< DataType > second)
 The == operator More...
 

Protected Member Functions

 ParameterBase (string ID, DataType Value, ParameterDirection Direction=ParameterDirection.Input, string ParameterStarter="@")
 Constructor More...
 
 ParameterBase (string ID, SqlDbType Type, object Value=null, ParameterDirection Direction=ParameterDirection.Input, string ParameterStarter="@")
 Constructor More...
 
 ParameterBase (string ID, DbType Type, object Value=null, ParameterDirection Direction=ParameterDirection.Input, string ParameterStarter="@")
 Constructor More...
 

Properties

virtual DbType DatabaseType [get, set]
 Database type More...
 
virtual ParameterDirection Direction [get, set]
 Direction of the parameter More...
 
virtual string ID [get, set]
 The Name that the parameter goes by More...
 
object InternalValue [get]
 Gets the internal value. More...
 
string ParameterStarter [get, set]
 Starting string of the parameter More...
 
virtual DataType Value [get, set]
 Parameter value More...
 
virtual string BatchID [get, set]
 Batch ID More...
 
- Properties inherited from Utilities.ORM.Manager.QueryProvider.Interfaces.IParameter< DataType >
Value [get, set]
 The value that the parameter is associated with More...
 
DbType DatabaseType [get, set]
 Database type More...
 
ParameterDirection Direction [get, set]
 Direction of the parameter More...
 
string ID [get, set]
 The name that the parameter goes by More...
 
object InternalValue [get]
 Gets the internal value. More...
 

Detailed Description

Parameter base class

Template Parameters
DataTypeData type of the parameter

Definition at line 34 of file ParameterBase.cs.

Constructor & Destructor Documentation

Utilities.ORM.Manager.QueryProvider.BaseClasses.ParameterBase< DataType >.ParameterBase ( string  ID,
DataType  Value,
ParameterDirection  Direction = ParameterDirection.Input,
string  ParameterStarter = "@" 
)
protected

Constructor

Parameters
IDID of the parameter
ValueValue of the parameter
DirectionDirection of the parameter
ParameterStarterWhat the database expects as the parameter starting string ("@" for SQL Server, ":" for Oracle, etc.)

Definition at line 46 of file ParameterBase.cs.

Utilities.ORM.Manager.QueryProvider.BaseClasses.ParameterBase< DataType >.ParameterBase ( string  ID,
SqlDbType  Type,
object  Value = null,
ParameterDirection  Direction = ParameterDirection.Input,
string  ParameterStarter = "@" 
)
protected

Constructor

Parameters
IDID of the parameter
TypeDatabase type
ValueValue of the parameter
DirectionDirection of the parameter
ParameterStarterWhat the database expects as the parameter starting string ("@" for SQL Server, ":" for Oracle, etc.)

Definition at line 62 of file ParameterBase.cs.

Utilities.ORM.Manager.QueryProvider.BaseClasses.ParameterBase< DataType >.ParameterBase ( string  ID,
DbType  Type,
object  Value = null,
ParameterDirection  Direction = ParameterDirection.Input,
string  ParameterStarter = "@" 
)
protected

Constructor

Parameters
IDID of the parameter
TypeDatabase type
ValueValue of the parameter
DirectionDirection of the parameter
ParameterStarterWhat the database expects as the parameter starting string ("@" for SQL Server, ":" for Oracle, etc.)

Definition at line 78 of file ParameterBase.cs.

Member Function Documentation

string Utilities.ORM.Manager.QueryProvider.BaseClasses.ParameterBase< DataType >.AddParameter ( string  Command)

Finds itself in the string command and adds the value

Parameters
CommandCommand to add to
Returns
The resulting string

Definition at line 163 of file ParameterBase.cs.

override bool Utilities.ORM.Manager.QueryProvider.BaseClasses.ParameterBase< DataType >.Equals ( object  obj)

Determines if the objects are equal

Parameters
objObject to compare to
Returns
True if they are equal, false otherwise

Definition at line 183 of file ParameterBase.cs.

override int Utilities.ORM.Manager.QueryProvider.BaseClasses.ParameterBase< DataType >.GetHashCode ( )

Gets the hash code for the object

Returns
The hash code

Definition at line 197 of file ParameterBase.cs.

static bool Utilities.ORM.Manager.QueryProvider.BaseClasses.ParameterBase< DataType >.operator!= ( ParameterBase< DataType >  first,
ParameterBase< DataType >  second 
)
static

!= operator

Parameters
firstFirst item
secondSecond item
Returns
returns true if they are not equal, false otherwise

Definition at line 130 of file ParameterBase.cs.

static bool Utilities.ORM.Manager.QueryProvider.BaseClasses.ParameterBase< DataType >.operator== ( ParameterBase< DataType >  first,
ParameterBase< DataType >  second 
)
static

The == operator

Parameters
firstFirst item
secondSecond item
Returns
true if the first and second item are the same, false otherwise

Definition at line 141 of file ParameterBase.cs.

override string Utilities.ORM.Manager.QueryProvider.BaseClasses.ParameterBase< DataType >.ToString ( )

Returns the string version of the parameter

Returns
The string representation of the parameter

Definition at line 209 of file ParameterBase.cs.

Property Documentation

virtual string Utilities.ORM.Manager.QueryProvider.BaseClasses.ParameterBase< DataType >.BatchID
getsetprotected

Batch ID

Definition at line 122 of file ParameterBase.cs.

virtual DbType Utilities.ORM.Manager.QueryProvider.BaseClasses.ParameterBase< DataType >.DatabaseType
getset

Database type

Definition at line 91 of file ParameterBase.cs.

virtual ParameterDirection Utilities.ORM.Manager.QueryProvider.BaseClasses.ParameterBase< DataType >.Direction
getset

Direction of the parameter

Definition at line 96 of file ParameterBase.cs.

The Name that the parameter goes by

Definition at line 101 of file ParameterBase.cs.

Gets the internal value.

The internal value.

Definition at line 107 of file ParameterBase.cs.

string Utilities.ORM.Manager.QueryProvider.BaseClasses.ParameterBase< DataType >.ParameterStarter
getset

Starting string of the parameter

Definition at line 112 of file ParameterBase.cs.

virtual DataType Utilities.ORM.Manager.QueryProvider.BaseClasses.ParameterBase< DataType >.Value
getset

Parameter value

Definition at line 117 of file ParameterBase.cs.


The documentation for this class was generated from the following file: