Craig's Utility Library  4.0 Beta
Utilities.ORM.Parameters.BetweenParameter< DataType > Class Template Reference

Parameter class that checks if a value is between two other values More...

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

Public Member Functions

 BetweenParameter (DataType Min, DataType Max, string ID, string ParameterStarter="@")
 Constructor More...
 
override void AddParameter (DbCommand Helper)
 Adds the parameter to the SQLHelper More...
 
override IParameter CreateCopy (string Suffix)
 Creates a copy of the parameter More...
 
override string ToString ()
 Outputs the param as a string More...
 
- Public Member Functions inherited from Utilities.ORM.Manager.QueryProvider.BaseClasses.ParameterBase< DataType >
string AddParameter (string Command)
 Finds itself in the string command and adds the value 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...
 

Properties

DataType Max [get, set]
 Max value of the parameter More...
 
DataType Min [get, set]
 Min value of the parameter More...
 
- Properties inherited from Utilities.ORM.Manager.QueryProvider.BaseClasses.ParameterBase< DataType >
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...
 

Additional Inherited Members

- Static Public Member Functions inherited from Utilities.ORM.Manager.QueryProvider.BaseClasses.ParameterBase< DataType >
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 inherited from Utilities.ORM.Manager.QueryProvider.BaseClasses.ParameterBase< DataType >
 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...
 

Detailed Description

Parameter class that checks if a value is between two other values

Template Parameters
DataTypeType of the parameter

Definition at line 32 of file BetweenParameter.cs.

Constructor & Destructor Documentation

Utilities.ORM.Parameters.BetweenParameter< DataType >.BetweenParameter ( DataType  Min,
DataType  Max,
string  ID,
string  ParameterStarter = "@" 
)

Constructor

Parameters
MinMin value of the parameter
MaxMax value of the parameter
IDName of the parameter
ParameterStarterWhat the database expects as the parameter starting string ("@" for SQL Server, ":" for Oracle, etc.)

Definition at line 44 of file BetweenParameter.cs.

Member Function Documentation

override void Utilities.ORM.Parameters.BetweenParameter< DataType >.AddParameter ( DbCommand  Helper)
virtual

Adds the parameter to the SQLHelper

Parameters
HelperSQLHelper to add the parameter to

Implements Utilities.ORM.Manager.QueryProvider.BaseClasses.ParameterBase< DataType >.

Definition at line 65 of file BetweenParameter.cs.

override IParameter Utilities.ORM.Parameters.BetweenParameter< DataType >.CreateCopy ( string  Suffix)
virtual

Creates a copy of the parameter

Parameters
SuffixSuffix to add to the parameter (for batching purposes)
Returns
A copy of the parameter

Implements Utilities.ORM.Manager.QueryProvider.BaseClasses.ParameterBase< DataType >.

Definition at line 76 of file BetweenParameter.cs.

override string Utilities.ORM.Parameters.BetweenParameter< DataType >.ToString ( )

Outputs the param as a string

Returns
The param as a string

Definition at line 85 of file BetweenParameter.cs.

Property Documentation

DataType Utilities.ORM.Parameters.BetweenParameter< DataType >.Max
getset

Max value of the parameter

Definition at line 54 of file BetweenParameter.cs.

DataType Utilities.ORM.Parameters.BetweenParameter< DataType >.Min
getset

Min value of the parameter

Definition at line 59 of file BetweenParameter.cs.


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