Software and Services, Portable Libraries  2019.Mar.01
A library for managing digital certificates
SoftwareAndServices::Library::Database::SqlColumnForeignKey Class Reference

Column Foreign Key. More...

#include <SaS/Sql/Types.hpp>

+ Inheritance diagram for SoftwareAndServices::Library::Database::SqlColumnForeignKey:
+ Collaboration diagram for SoftwareAndServices::Library::Database::SqlColumnForeignKey:

Public Member Functions

 SqlColumnForeignKey ()
 SqlColumnForeignKey - Default Constructor. More...
 
 SqlColumnForeignKey (const SqlColumnForeignKey &CopyFrom)
 SqlColumnForeignKey - Copy Constructor. More...
 
virtual ~SqlColumnForeignKey ()
 SqlColumnForeignKey - Destructor. More...
 
SqlFkAction_e Action () const
 
void Action (SqlFkAction_e Act)
 Set the ACTION. More...
 
SqlFkActionType_e ActionType () const
 
void ActionType (SqlFkActionType_e AType)
 Set the ACTION TYPE. More...
 
const char * ForeignKeyName () const
 
void ForeignKeyName (const char *FkName)
 Set the FOREIGN KEY name. More...
 
const char * LocalColumnName () const
 
void LocalColumnName (const char *ColName)
 Set the LOCAL column name. More...
 
SqlFkMatchType_e MatchType () const
 
void MatchType (SqlFkMatchType_e AType)
 Set the MATCH TYPE. More...
 
bool operator!= (const SqlColumnForeignKey &Other)
 Compare Operator. More...
 
bool operator== (const SqlColumnForeignKey &Other)
 Compare Operator. More...
 
SqlColumnReferenceColumn () const
 
void ReferenceColumn (SqlColumn *RefCol)
 Set the REFERENCE column. More...
 
const char * ReferenceColumnName () const
 
void ReferenceColumnName (const char *RefColName)
 Set the REFERENCE column name. More...
 
SqlTableReferenceTable () const
 
void ReferenceTable (SqlTable *RefTable)
 Set the REFERENCE table. More...
 
const char * ReferenceTableName () const
 
void ReferenceTableName (const char *RefTableName)
 Set the REFERENCE table name. More...
 
void Set (SqlTable *RefTable, SqlColumn *RefCol)
 Set the values. More...
 

Static Public Member Functions

static void CreateCpp ()
 Create the C++ code for all SQL Function objects. More...
 

Detailed Description

Column Foreign Key.

Definition at line 875 of file Types.hpp.

Constructor & Destructor Documentation

◆ SqlColumnForeignKey() [1/2]

SoftwareAndServices::Library::Database::SqlColumnForeignKey::SqlColumnForeignKey ( )

SqlColumnForeignKey - Default Constructor.

◆ SqlColumnForeignKey() [2/2]

SoftwareAndServices::Library::Database::SqlColumnForeignKey::SqlColumnForeignKey ( const SqlColumnForeignKey CopyFrom)

SqlColumnForeignKey - Copy Constructor.

Parameters
CopyFromThe SqlColumnForeignKey to copy from.

◆ ~SqlColumnForeignKey()

virtual SoftwareAndServices::Library::Database::SqlColumnForeignKey::~SqlColumnForeignKey ( )
virtual

SqlColumnForeignKey - Destructor.

Member Function Documentation

◆ Action() [1/2]

SqlFkAction_e SoftwareAndServices::Library::Database::SqlColumnForeignKey::Action ( ) const
Returns
the ACTION

◆ Action() [2/2]

void SoftwareAndServices::Library::Database::SqlColumnForeignKey::Action ( SqlFkAction_e  Act)

Set the ACTION.

Parameters
ActThe sql_fk_action

◆ ActionType() [1/2]

SqlFkActionType_e SoftwareAndServices::Library::Database::SqlColumnForeignKey::ActionType ( ) const
Returns
the ACTION TYPE

◆ ActionType() [2/2]

void SoftwareAndServices::Library::Database::SqlColumnForeignKey::ActionType ( SqlFkActionType_e  AType)

Set the ACTION TYPE.

Parameters
ATypeThe sql_fk_action

◆ CreateCpp()

static void SoftwareAndServices::Library::Database::SqlColumnForeignKey::CreateCpp ( )
static

Create the C++ code for all SQL Function objects.

◆ ForeignKeyName() [1/2]

const char* SoftwareAndServices::Library::Database::SqlColumnForeignKey::ForeignKeyName ( ) const
Returns
the FOREIGN KEY name, or NULL when none set.

◆ ForeignKeyName() [2/2]

void SoftwareAndServices::Library::Database::SqlColumnForeignKey::ForeignKeyName ( const char *  FkName)

Set the FOREIGN KEY name.

Parameters
FkNameThe name of the FOREIGN KEY.

◆ LocalColumnName() [1/2]

const char* SoftwareAndServices::Library::Database::SqlColumnForeignKey::LocalColumnName ( ) const
Returns
the LOCAL column name, or NULL if not set.

◆ LocalColumnName() [2/2]

void SoftwareAndServices::Library::Database::SqlColumnForeignKey::LocalColumnName ( const char *  ColName)

Set the LOCAL column name.

Parameters
ColNameThe LOCAL column name.

◆ MatchType() [1/2]

SqlFkMatchType_e SoftwareAndServices::Library::Database::SqlColumnForeignKey::MatchType ( ) const
Returns
the MATCH TYPE

◆ MatchType() [2/2]

void SoftwareAndServices::Library::Database::SqlColumnForeignKey::MatchType ( SqlFkMatchType_e  AType)

Set the MATCH TYPE.

Parameters
MTypeThe sql_fk_match_type

◆ operator!=()

bool SoftwareAndServices::Library::Database::SqlColumnForeignKey::operator!= ( const SqlColumnForeignKey Other)

Compare Operator.

Parameters
OtherThe other object to compare to.
Returns
true when they do not have the same values.

◆ operator==()

bool SoftwareAndServices::Library::Database::SqlColumnForeignKey::operator== ( const SqlColumnForeignKey Other)

Compare Operator.

Parameters
OtherThe other object to compare to.
Returns
true when they have the same values.

◆ ReferenceColumn() [1/2]

SqlColumn* SoftwareAndServices::Library::Database::SqlColumnForeignKey::ReferenceColumn ( ) const
Returns
the REFERENCE column.

◆ ReferenceColumn() [2/2]

void SoftwareAndServices::Library::Database::SqlColumnForeignKey::ReferenceColumn ( SqlColumn RefCol)

Set the REFERENCE column.

Parameters
RefColThe REFERENCE column.

◆ ReferenceColumnName() [1/2]

const char* SoftwareAndServices::Library::Database::SqlColumnForeignKey::ReferenceColumnName ( ) const
Returns
the REFERENCE column name.

◆ ReferenceColumnName() [2/2]

void SoftwareAndServices::Library::Database::SqlColumnForeignKey::ReferenceColumnName ( const char *  RefColName)

Set the REFERENCE column name.

Parameters
RefColNameThe REFERENCE column name.

◆ ReferenceTable() [1/2]

SqlTable* SoftwareAndServices::Library::Database::SqlColumnForeignKey::ReferenceTable ( ) const
Returns
the REFERENCE table pointer.

◆ ReferenceTable() [2/2]

void SoftwareAndServices::Library::Database::SqlColumnForeignKey::ReferenceTable ( SqlTable RefTable)

Set the REFERENCE table.

Parameters
RefTableThe REFERENCE table.

◆ ReferenceTableName() [1/2]

const char* SoftwareAndServices::Library::Database::SqlColumnForeignKey::ReferenceTableName ( ) const
Returns
the REFERENCE table name.

◆ ReferenceTableName() [2/2]

void SoftwareAndServices::Library::Database::SqlColumnForeignKey::ReferenceTableName ( const char *  RefTableName)

Set the REFERENCE table name.

Parameters
RefTableNameThe REFERENCE table name.

◆ Set()

void SoftwareAndServices::Library::Database::SqlColumnForeignKey::Set ( SqlTable RefTable,
SqlColumn RefCol 
)

Set the values.

Parameters
RefTableThe table.
RefColThe column.

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