OpenPetra
Free Administration Software for Non-Profits
Ict.Common.Data.TRowReferenceInfo Class Reference

Data Class that holds information about DB Rows referencing another DB Row. More...

Public Member Functions

 TRowReferenceInfo (string AThisTable, string AThisTableLabel, Dictionary< string, object >APKInfo, List< KeyValuePair< string, TRowReferenceInfo > >AOtherTableRefs)
 Constructor. More...
 
 TRowReferenceInfo (string AThisTable, string AThisTableLabel, long AReferenceCount, DataRow ADataRow, int ANestingDepth)
 Constructor. More...
 
void SetReferenceCount (long AReferenceCount)
 Allows the setting of the ReferenceCount Property. Introduced so that the ReferenceCount Property can stay read-only, which it should be. More...
 
void SetPKInfo (Dictionary< string, object >APKInfo)
 Allows the setting of the PKInfo Property. Introduced so that the PKInfo Property can stay read-only, which it should be. More...
 
void PopulatePKInfoDataFromDataRow ()
 Populates missing data in the Value part of the PKInfo Property from the data in the DataRow (which must contain only Primary Key data for this to work). More...
 

Properties

bool CascadingCountEndedEarly [get, set]
 Gets/Sets if the cascading count ended early because the reference count was greater than the MaxReferences specified by the caller More...
 
string ThisTable [get]
 Name of the DB Table (as in the DB) that holds the DB Row in question. More...
 
string ThisTableLabel [get]
 Label (='friendly name' for the user) of the DB Table that holds the DB Row in question. More...
 
bool RootTable [get]
 True if this instance is for the 'root' table in a cascading table hierarachy. More...
 
int NestingDepth [get]
 The depth of how deep this instance of TRowReferenceInfo is nested More...
 
Dictionary< string, object > PKInfo [get]
 Dictionary<T,T> consisting of a string-object pair for each Primary Key Column. The string (Key) is the Label ('friendly name' for the user) of the PK Column and the object (Value) holds the actual data of the PK Column. More...
 
long ReferenceCount [get]
 Number of references that point to the DB Row in question. More...
 
List< KeyValuePair< string, TRowReferenceInfo > > OtherTableRefs [get]
 References to the DB Row in question. More...
 
DataRow DataRow [get]
 Referencing DataRow. More...
 
object[] DataRowContents [get]
 Data of the referencing DataRow represented as an Array of object. Use this for accesing the data of the referencing DataRow when the instance of this class got remoted using .NET Remoting. More...
 

Detailed Description

Data Class that holds information about DB Rows referencing another DB Row.

Constructor & Destructor Documentation

◆ TRowReferenceInfo() [1/2]

Ict.Common.Data.TRowReferenceInfo.TRowReferenceInfo ( string  AThisTable,
string  AThisTableLabel,
Dictionary< string, object >  APKInfo,
List< KeyValuePair< string, TRowReferenceInfo > >  AOtherTableRefs 
)
inline

Constructor.

Parameters
AThisTableName of the DB Table (as in the DB) that holds the DB Row in question.
AThisTableLabelLabel (='friendly name' for the user) of the DB Table that holds the DB Row in question.
APKInfoDictionary<T,T> consisting of a string-object pair for each Primary Key Column. The string (Key) is the Label ('friendly name' for the user) of the PK Column and the object (Value) holds the actual data of the PK Column.
AOtherTableRefsReferences to the DB Row in question.

◆ TRowReferenceInfo() [2/2]

Ict.Common.Data.TRowReferenceInfo.TRowReferenceInfo ( string  AThisTable,
string  AThisTableLabel,
long  AReferenceCount,
DataRow  ADataRow,
int  ANestingDepth 
)
inline

Constructor.

Parameters
AThisTableName of the DB Table (as in the DB) that holds the DB Row in question.
AThisTableLabelLabel (='friendly name') of the DB Table that holds the DB Row in question.
AReferenceCountReferences count.
ADataRowReferencing DataRow.
ANestingDepthThe depth of how deep this instance of TRowReferenceInfo is nested.

Member Function Documentation

◆ PopulatePKInfoDataFromDataRow()

void Ict.Common.Data.TRowReferenceInfo.PopulatePKInfoDataFromDataRow ( )
inline

Populates missing data in the Value part of the PKInfo Property from the data in the DataRow (which must contain only Primary Key data for this to work).

◆ SetPKInfo()

void Ict.Common.Data.TRowReferenceInfo.SetPKInfo ( Dictionary< string, object >  APKInfo)
inline

Allows the setting of the PKInfo Property. Introduced so that the PKInfo Property can stay read-only, which it should be.

Parameters
APKInfoSee PKInfo Property.

◆ SetReferenceCount()

void Ict.Common.Data.TRowReferenceInfo.SetReferenceCount ( long  AReferenceCount)
inline

Allows the setting of the ReferenceCount Property. Introduced so that the ReferenceCount Property can stay read-only, which it should be.

Parameters
AReferenceCountReference Count.

Property Documentation

◆ CascadingCountEndedEarly

bool Ict.Common.Data.TRowReferenceInfo.CascadingCountEndedEarly
getset

Gets/Sets if the cascading count ended early because the reference count was greater than the MaxReferences specified by the caller

◆ DataRow

DataRow Ict.Common.Data.TRowReferenceInfo.DataRow
get

Referencing DataRow.

Does not get serialised because the DataRow Class is not Serializable. Use DataRowContents for accesing the data of the referencing DataRow instead in this case!

◆ DataRowContents

object [] Ict.Common.Data.TRowReferenceInfo.DataRowContents
get

Data of the referencing DataRow represented as an Array of object. Use this for accesing the data of the referencing DataRow when the instance of this class got remoted using .NET Remoting.

◆ NestingDepth

int Ict.Common.Data.TRowReferenceInfo.NestingDepth
get

The depth of how deep this instance of TRowReferenceInfo is nested

◆ OtherTableRefs

List<KeyValuePair <string, TRowReferenceInfo> > Ict.Common.Data.TRowReferenceInfo.OtherTableRefs
get

References to the DB Row in question.

◆ PKInfo

Dictionary<string, object> Ict.Common.Data.TRowReferenceInfo.PKInfo
get

Dictionary<T,T> consisting of a string-object pair for each Primary Key Column. The string (Key) is the Label ('friendly name' for the user) of the PK Column and the object (Value) holds the actual data of the PK Column.

◆ ReferenceCount

long Ict.Common.Data.TRowReferenceInfo.ReferenceCount
get

Number of references that point to the DB Row in question.

◆ RootTable

bool Ict.Common.Data.TRowReferenceInfo.RootTable
get

True if this instance is for the 'root' table in a cascading table hierarachy.

◆ ThisTable

string Ict.Common.Data.TRowReferenceInfo.ThisTable
get

Name of the DB Table (as in the DB) that holds the DB Row in question.

◆ ThisTableLabel

string Ict.Common.Data.TRowReferenceInfo.ThisTableLabel
get

Label (='friendly name' for the user) of the DB Table that holds the DB Row in question.


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