OpenPetra
Free Administration Software for Non-Profits
Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable Class Reference

Stores administrative fees and grants which have been calculated on gifts. More...

Inheritance diagram for Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable:
Ict.Common.Data.TTypedDataTable

Public Member Functions

 AProcessedFeeTable ()
 constructor More...
 
 AProcessedFeeTable (string ATablename)
 constructor More...
 
 AProcessedFeeTable (System.Runtime.Serialization.SerializationInfo info, System.Runtime.Serialization.StreamingContext context)
 constructor for serialization More...
 
override void InitVars ()
 assign columns to properties, set primary key More...
 
AProcessedFeeRow NewRowTyped (bool AWithDefaultValues)
 create a new typed row More...
 
AProcessedFeeRow NewRowTyped ()
 create a new typed row, always with default values More...
 
AProcessedFeeTable GetChangesTyped ()
 get typed set of changes More...
 
override OdbcParameter CreateOdbcParameter (Int32 AColumnNr)
 get an odbc parameter for the given column More...
 
new DataTable GetChanges ()
 make sure that we use GetChangesType instead of GetChanges More...
 
virtual string GetCustomReportPermission ()
 string to indicate which permissions a user needs to access table for custom reports (e.g. "PTNRUSER", "OR(FINANCE-1,DEVUSER)", "AND(PTNRUSER,FINANCE-1)" This should be returned by method in derived class More...
 
virtual bool IsAvailableForCustomReport ()
 Is this table generally available in custom reports? More...
 
virtual List< String > GetCustomReportFieldList ()
 Return a list of fields that are available for custom reports More...
 
DataTable GetChangesTypedInternal ()
 our own version of GetChanges More...
 
void RemoveColumnsNotInTableTemplate (DataTable ATableTemplate)
 remove columns that are not needed More...
 

Static Public Member Functions

static string GetTableName ()
 return the CamelCase name of the table More...
 
static string GetTableDBName ()
 return the name of the table as it is used in the database More...
 
static string GetTableDBLabel ()
 static method to return the 'Label' of the table as it is used in the database (the 'Label' is usually a short description of what the db table is about) More...
 
static string GetLedgerNumberDBName ()
 get the name of the field in the database for this column More...
 
static short GetLedgerNumberLength ()
 get character length for column More...
 
static string GetLedgerNumberHelp ()
 get the help text for the field in the database for this column More...
 
static string GetBatchNumberDBName ()
 get the name of the field in the database for this column More...
 
static short GetBatchNumberLength ()
 get character length for column More...
 
static string GetBatchNumberHelp ()
 get the help text for the field in the database for this column More...
 
static string GetGiftTransactionNumberDBName ()
 get the name of the field in the database for this column More...
 
static short GetGiftTransactionNumberLength ()
 get character length for column More...
 
static string GetGiftTransactionNumberHelp ()
 get the help text for the field in the database for this column More...
 
static string GetDetailNumberDBName ()
 get the name of the field in the database for this column More...
 
static short GetDetailNumberLength ()
 get character length for column More...
 
static string GetDetailNumberHelp ()
 get the help text for the field in the database for this column More...
 
static string GetFeeCodeDBName ()
 get the name of the field in the database for this column More...
 
static short GetFeeCodeLength ()
 get character length for column More...
 
static string GetFeeCodeHelp ()
 get the help text for the field in the database for this column More...
 
static string GetCostCentreCodeDBName ()
 get the name of the field in the database for this column More...
 
static short GetCostCentreCodeLength ()
 get character length for column More...
 
static string GetCostCentreCodeHelp ()
 get the help text for the field in the database for this column More...
 
static string GetPeriodNumberDBName ()
 get the name of the field in the database for this column More...
 
static short GetPeriodNumberLength ()
 get character length for column More...
 
static string GetPeriodNumberHelp ()
 get the help text for the field in the database for this column More...
 
static string GetPeriodicAmountDBName ()
 get the name of the field in the database for this column More...
 
static short GetPeriodicAmountLength ()
 get character length for column More...
 
static string GetPeriodicAmountHelp ()
 get the help text for the field in the database for this column More...
 
static string GetProcessedDateDBName ()
 get the name of the field in the database for this column More...
 
static short GetProcessedDateLength ()
 get character length for column More...
 
static string GetProcessedDateHelp ()
 get the help text for the field in the database for this column More...
 
static string GetTimestampDBName ()
 get the name of the field in the database for this column More...
 
static short GetTimestampLength ()
 get character length for column More...
 
static string GetTimestampHelp ()
 get the help text for the field in the database for this column More...
 
static string GetDateCreatedDBName ()
 get the name of the field in the database for this column More...
 
static short GetDateCreatedLength ()
 get character length for column More...
 
static string GetDateCreatedHelp ()
 get the help text for the field in the database for this column More...
 
static string GetCreatedByDBName ()
 get the name of the field in the database for this column More...
 
static short GetCreatedByLength ()
 get character length for column More...
 
static string GetCreatedByHelp ()
 get the help text for the field in the database for this column More...
 
static string GetDateModifiedDBName ()
 get the name of the field in the database for this column More...
 
static short GetDateModifiedLength ()
 get character length for column More...
 
static string GetDateModifiedHelp ()
 get the help text for the field in the database for this column More...
 
static string GetModifiedByDBName ()
 get the name of the field in the database for this column More...
 
static short GetModifiedByLength ()
 get character length for column More...
 
static string GetModifiedByHelp ()
 get the help text for the field in the database for this column More...
 
static string GetModificationIdDBName ()
 get the name of the field in the database for this column More...
 
static short GetModificationIdLength ()
 get character length for column More...
 
static string GetModificationIdHelp ()
 get the help text for the field in the database for this column More...
 
static OdbcParameter CreateOdbcParameter (short ATableNumber, TSearchCriteria ASearchCriteria)
 create an odbc parameter for the given column More...
 
static OdbcParameter CreateOdbcParameter (short ATableNumber, Int32 AColumnNr)
 create an odbc parameter for the given column More...
 
static void ResetStaticVariables ()
 reset the static variables for each Web Request call. More...
 
static string GetTableNameSQL (short ATableNumber)
 the table name as it is in the SQL database More...
 
static string GetTableName (short ATableNumber)
 the table name in CamelCase More...
 
static TTypedTableInfo GetTableByName (string ATableName)
 the table name in CamelCase More...
 
static string GetColumnNameSQL (short ATableNumber, short AColumnNr)
 the column name as it is in the SQL database More...
 
static string GetLabel (short ATableNumber, short AColumnNr)
 returns the translated label for the column More...
 
static Int32 GetLength (short ATableNumber, short AColumnNr)
 get the maximum length for the field More...
 
static Int32 GetLength (string ATableName, string AColumnName)
 get the maximum length for the field More...
 
static string[] GetKeyColumnStringList (short ATableNumber, int[] AKeyColumnsOrder)
 get the names of the columns that are part of the key More...
 
static string[] GetPrimaryKeyColumnStringList (short ATableNumber)
 get the names of the columns that are part of the primary key More...
 
static string[] GetUniqueKeyColumnStringList (short ATableNumber)
 get the names of the columns that are part of the unique key More...
 
static int[] GetPrimaryKeyColumnOrdList (short ATableNumber)
 get the order number of the columns that are part of the primary key More...
 
static int[] GetUniqueKeyColumnOrdList (short ATableNumber)
 get the order number of the columns that are part of a unique key More...
 
static string[] GetColumnStringList (short ATableNumber)
 get the names of the columns in this table More...
 

Public Attributes

DataColumn ColumnLedgerNumber
 This is used as a key field in most of the accounting system files. More...
 
DataColumn ColumnBatchNumber
 Number of the gift batch containing this detail. More...
 
DataColumn ColumnGiftTransactionNumber
 Identifies a gift transaction within a gift batch. More...
 
DataColumn ColumnDetailNumber
 Identifies a gift detail within a gift transaction. When a donor gives a donation to multiple recipients (a split gift), a gift detail record is created for each recipient. More...
 
DataColumn ColumnFeeCode
 the fee which the calculated amounts are stored against. More...
 
DataColumn ColumnCostCentreCode
 Cost centre code which the fee will be charged against. More...
 
DataColumn ColumnPeriodNumber
 Period number. More...
 
DataColumn ColumnPeriodicAmount
 Total Amount of the fee for the given period. More...
 
DataColumn ColumnProcessedDate
 Date ""admin fee calculations"" have been run to fee total has been created as a transaction in the general ledger. More...
 
DataColumn ColumnTimestamp
 System generated time stamp. More...
 
DataColumn ColumnDateCreated
 The date the record was created. More...
 
DataColumn ColumnCreatedBy
 User ID of who created this record. More...
 
DataColumn ColumnDateModified
 The date the record was modified. More...
 
DataColumn ColumnModifiedBy
 User ID of who last modified this record. More...
 
DataColumn ColumnModificationId
 This identifies the current version of the record. More...
 
bool ThrowAwayAfterSubmitChanges = false
 if you want the datatable to be cleared after submitchanges. This will increase the speed significantly: no updating of modificationID, no slow AcceptChanges. More...
 
bool DontThrowAwayAfterSubmitChanges = false
 if you want no warning about that the datatable should be cleared after submitchanges. in some cases you must keep the data, eg when you need the new keys after INSERT More...
 

Static Public Attributes

static readonly short TableId = 149
 TableId for Ict.Common.Data generic functions. More...
 
static readonly short ColumnLedgerNumberId = 0
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnBatchNumberId = 1
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnGiftTransactionNumberId = 2
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnDetailNumberId = 3
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnFeeCodeId = 4
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnCostCentreCodeId = 5
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnPeriodNumberId = 6
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnPeriodicAmountId = 7
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnProcessedDateId = 8
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnTimestampId = 9
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnDateCreatedId = 10
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnCreatedById = 11
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnDateModifiedId = 12
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnModifiedById = 13
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnModificationIdId = 14
 used for generic TTypedDataTable functions More...
 

Protected Member Functions

override void InitClass ()
 create the columns More...
 
override System.Data.DataRow NewRowFromBuilder (System.Data.DataRowBuilder builder)
 new typed row using DataRowBuilder More...
 

Static Protected Attributes

static SortedList< short, TTypedTableInfoTableInfo = new SortedList <short, TTypedTableInfo>()
 stores information about typed tables More...
 

Properties

AProcessedFeeRow this[int i] [get]
 Access a typed row by index. More...
 
override string TableDBLabel [get]
 instance property to get the 'Label' of the table as it is used in the database (the 'Label' is usually a short description of what the db table is about) More...
 
int Count [get]
 the number of rows in the current table More...
 

Detailed Description

Stores administrative fees and grants which have been calculated on gifts.

Constructor & Destructor Documentation

◆ AProcessedFeeTable() [1/3]

Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.AProcessedFeeTable ( )
inline

constructor

◆ AProcessedFeeTable() [2/3]

Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.AProcessedFeeTable ( string  ATablename)
inline

constructor

◆ AProcessedFeeTable() [3/3]

Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.AProcessedFeeTable ( System.Runtime.Serialization.SerializationInfo  info,
System.Runtime.Serialization.StreamingContext  context 
)
inline

constructor for serialization

Member Function Documentation

◆ CreateOdbcParameter() [1/3]

override OdbcParameter Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.CreateOdbcParameter ( Int32  AColumnNr)
inlinevirtual

get an odbc parameter for the given column

Implements Ict.Common.Data.TTypedDataTable.

◆ CreateOdbcParameter() [2/3]

static OdbcParameter Ict.Common.Data.TTypedDataTable.CreateOdbcParameter ( short  ATableNumber,
Int32  AColumnNr 
)
inlinestaticinherited

create an odbc parameter for the given column

◆ CreateOdbcParameter() [3/3]

static OdbcParameter Ict.Common.Data.TTypedDataTable.CreateOdbcParameter ( short  ATableNumber,
TSearchCriteria  ASearchCriteria 
)
inlinestaticinherited

create an odbc parameter for the given column

◆ GetBatchNumberDBName()

static string Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.GetBatchNumberDBName ( )
inlinestatic

get the name of the field in the database for this column

◆ GetBatchNumberHelp()

static string Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.GetBatchNumberHelp ( )
inlinestatic

get the help text for the field in the database for this column

◆ GetBatchNumberLength()

static short Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.GetBatchNumberLength ( )
inlinestatic

get character length for column

◆ GetChanges()

new DataTable Ict.Common.Data.TTypedDataTable.GetChanges ( )
inlineinherited

make sure that we use GetChangesType instead of GetChanges

Returns
throws an exception

◆ GetChangesTyped()

AProcessedFeeTable Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.GetChangesTyped ( )
inline

get typed set of changes

◆ GetChangesTypedInternal()

DataTable Ict.Common.Data.TTypedDataTable.GetChangesTypedInternal ( )
inlineinherited

our own version of GetChanges

Returns
returns a typed table with the changes

◆ GetColumnNameSQL()

static string Ict.Common.Data.TTypedDataTable.GetColumnNameSQL ( short  ATableNumber,
short  AColumnNr 
)
inlinestaticinherited

the column name as it is in the SQL database

◆ GetColumnStringList()

static string[] Ict.Common.Data.TTypedDataTable.GetColumnStringList ( short  ATableNumber)
inlinestaticinherited

get the names of the columns in this table

◆ GetCostCentreCodeDBName()

static string Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.GetCostCentreCodeDBName ( )
inlinestatic

get the name of the field in the database for this column

◆ GetCostCentreCodeHelp()

static string Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.GetCostCentreCodeHelp ( )
inlinestatic

get the help text for the field in the database for this column

◆ GetCostCentreCodeLength()

static short Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.GetCostCentreCodeLength ( )
inlinestatic

get character length for column

◆ GetCreatedByDBName()

static string Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.GetCreatedByDBName ( )
inlinestatic

get the name of the field in the database for this column

◆ GetCreatedByHelp()

static string Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.GetCreatedByHelp ( )
inlinestatic

get the help text for the field in the database for this column

◆ GetCreatedByLength()

static short Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.GetCreatedByLength ( )
inlinestatic

get character length for column

◆ GetCustomReportFieldList()

virtual List< String > Ict.Common.Data.TTypedDataTable.GetCustomReportFieldList ( )
inlinevirtualinherited

Return a list of fields that are available for custom reports

◆ GetCustomReportPermission()

virtual string Ict.Common.Data.TTypedDataTable.GetCustomReportPermission ( )
inlinevirtualinherited

string to indicate which permissions a user needs to access table for custom reports (e.g. "PTNRUSER", "OR(FINANCE-1,DEVUSER)", "AND(PTNRUSER,FINANCE-1)" This should be returned by method in derived class

◆ GetDateCreatedDBName()

static string Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.GetDateCreatedDBName ( )
inlinestatic

get the name of the field in the database for this column

◆ GetDateCreatedHelp()

static string Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.GetDateCreatedHelp ( )
inlinestatic

get the help text for the field in the database for this column

◆ GetDateCreatedLength()

static short Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.GetDateCreatedLength ( )
inlinestatic

get character length for column

◆ GetDateModifiedDBName()

static string Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.GetDateModifiedDBName ( )
inlinestatic

get the name of the field in the database for this column

◆ GetDateModifiedHelp()

static string Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.GetDateModifiedHelp ( )
inlinestatic

get the help text for the field in the database for this column

◆ GetDateModifiedLength()

static short Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.GetDateModifiedLength ( )
inlinestatic

get character length for column

◆ GetDetailNumberDBName()

static string Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.GetDetailNumberDBName ( )
inlinestatic

get the name of the field in the database for this column

◆ GetDetailNumberHelp()

static string Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.GetDetailNumberHelp ( )
inlinestatic

get the help text for the field in the database for this column

◆ GetDetailNumberLength()

static short Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.GetDetailNumberLength ( )
inlinestatic

get character length for column

◆ GetFeeCodeDBName()

static string Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.GetFeeCodeDBName ( )
inlinestatic

get the name of the field in the database for this column

◆ GetFeeCodeHelp()

static string Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.GetFeeCodeHelp ( )
inlinestatic

get the help text for the field in the database for this column

◆ GetFeeCodeLength()

static short Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.GetFeeCodeLength ( )
inlinestatic

get character length for column

◆ GetGiftTransactionNumberDBName()

static string Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.GetGiftTransactionNumberDBName ( )
inlinestatic

get the name of the field in the database for this column

◆ GetGiftTransactionNumberHelp()

static string Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.GetGiftTransactionNumberHelp ( )
inlinestatic

get the help text for the field in the database for this column

◆ GetGiftTransactionNumberLength()

static short Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.GetGiftTransactionNumberLength ( )
inlinestatic

get character length for column

◆ GetKeyColumnStringList()

static string[] Ict.Common.Data.TTypedDataTable.GetKeyColumnStringList ( short  ATableNumber,
int[]  AKeyColumnsOrder 
)
inlinestaticinherited

get the names of the columns that are part of the key

◆ GetLabel()

static string Ict.Common.Data.TTypedDataTable.GetLabel ( short  ATableNumber,
short  AColumnNr 
)
inlinestaticinherited

returns the translated label for the column

◆ GetLedgerNumberDBName()

static string Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.GetLedgerNumberDBName ( )
inlinestatic

get the name of the field in the database for this column

◆ GetLedgerNumberHelp()

static string Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.GetLedgerNumberHelp ( )
inlinestatic

get the help text for the field in the database for this column

◆ GetLedgerNumberLength()

static short Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.GetLedgerNumberLength ( )
inlinestatic

get character length for column

◆ GetLength() [1/2]

static Int32 Ict.Common.Data.TTypedDataTable.GetLength ( short  ATableNumber,
short  AColumnNr 
)
inlinestaticinherited

get the maximum length for the field

◆ GetLength() [2/2]

static Int32 Ict.Common.Data.TTypedDataTable.GetLength ( string  ATableName,
string  AColumnName 
)
inlinestaticinherited

get the maximum length for the field

◆ GetModificationIdDBName()

static string Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.GetModificationIdDBName ( )
inlinestatic

get the name of the field in the database for this column

◆ GetModificationIdHelp()

static string Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.GetModificationIdHelp ( )
inlinestatic

get the help text for the field in the database for this column

◆ GetModificationIdLength()

static short Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.GetModificationIdLength ( )
inlinestatic

get character length for column

◆ GetModifiedByDBName()

static string Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.GetModifiedByDBName ( )
inlinestatic

get the name of the field in the database for this column

◆ GetModifiedByHelp()

static string Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.GetModifiedByHelp ( )
inlinestatic

get the help text for the field in the database for this column

◆ GetModifiedByLength()

static short Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.GetModifiedByLength ( )
inlinestatic

get character length for column

◆ GetPeriodicAmountDBName()

static string Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.GetPeriodicAmountDBName ( )
inlinestatic

get the name of the field in the database for this column

◆ GetPeriodicAmountHelp()

static string Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.GetPeriodicAmountHelp ( )
inlinestatic

get the help text for the field in the database for this column

◆ GetPeriodicAmountLength()

static short Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.GetPeriodicAmountLength ( )
inlinestatic

get character length for column

◆ GetPeriodNumberDBName()

static string Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.GetPeriodNumberDBName ( )
inlinestatic

get the name of the field in the database for this column

◆ GetPeriodNumberHelp()

static string Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.GetPeriodNumberHelp ( )
inlinestatic

get the help text for the field in the database for this column

◆ GetPeriodNumberLength()

static short Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.GetPeriodNumberLength ( )
inlinestatic

get character length for column

◆ GetPrimaryKeyColumnOrdList()

static int[] Ict.Common.Data.TTypedDataTable.GetPrimaryKeyColumnOrdList ( short  ATableNumber)
inlinestaticinherited

get the order number of the columns that are part of the primary key

◆ GetPrimaryKeyColumnStringList()

static string[] Ict.Common.Data.TTypedDataTable.GetPrimaryKeyColumnStringList ( short  ATableNumber)
inlinestaticinherited

get the names of the columns that are part of the primary key

◆ GetProcessedDateDBName()

static string Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.GetProcessedDateDBName ( )
inlinestatic

get the name of the field in the database for this column

◆ GetProcessedDateHelp()

static string Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.GetProcessedDateHelp ( )
inlinestatic

get the help text for the field in the database for this column

◆ GetProcessedDateLength()

static short Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.GetProcessedDateLength ( )
inlinestatic

get character length for column

◆ GetTableByName()

static TTypedTableInfo Ict.Common.Data.TTypedDataTable.GetTableByName ( string  ATableName)
inlinestaticinherited

the table name in CamelCase

◆ GetTableDBLabel()

static string Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.GetTableDBLabel ( )
inlinestatic

static method to return the 'Label' of the table as it is used in the database (the 'Label' is usually a short description of what the db table is about)

◆ GetTableDBName()

static string Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.GetTableDBName ( )
inlinestatic

return the name of the table as it is used in the database

◆ GetTableName() [1/2]

static string Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.GetTableName ( )
inlinestatic

return the CamelCase name of the table

◆ GetTableName() [2/2]

static string Ict.Common.Data.TTypedDataTable.GetTableName ( short  ATableNumber)
inlinestaticinherited

the table name in CamelCase

◆ GetTableNameSQL()

static string Ict.Common.Data.TTypedDataTable.GetTableNameSQL ( short  ATableNumber)
inlinestaticinherited

the table name as it is in the SQL database

◆ GetTimestampDBName()

static string Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.GetTimestampDBName ( )
inlinestatic

get the name of the field in the database for this column

◆ GetTimestampHelp()

static string Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.GetTimestampHelp ( )
inlinestatic

get the help text for the field in the database for this column

◆ GetTimestampLength()

static short Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.GetTimestampLength ( )
inlinestatic

get character length for column

◆ GetUniqueKeyColumnOrdList()

static int[] Ict.Common.Data.TTypedDataTable.GetUniqueKeyColumnOrdList ( short  ATableNumber)
inlinestaticinherited

get the order number of the columns that are part of a unique key

◆ GetUniqueKeyColumnStringList()

static string[] Ict.Common.Data.TTypedDataTable.GetUniqueKeyColumnStringList ( short  ATableNumber)
inlinestaticinherited

get the names of the columns that are part of the unique key

◆ InitClass()

override void Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.InitClass ( )
inlineprotectedvirtual

create the columns

Implements Ict.Common.Data.TTypedDataTable.

◆ InitVars()

override void Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.InitVars ( )
inlinevirtual

assign columns to properties, set primary key

Implements Ict.Common.Data.TTypedDataTable.

◆ IsAvailableForCustomReport()

virtual bool Ict.Common.Data.TTypedDataTable.IsAvailableForCustomReport ( )
inlinevirtualinherited

Is this table generally available in custom reports?

◆ NewRowFromBuilder()

override System.Data.DataRow Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.NewRowFromBuilder ( System.Data.DataRowBuilder  builder)
inlineprotected

new typed row using DataRowBuilder

◆ NewRowTyped() [1/2]

AProcessedFeeRow Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.NewRowTyped ( )
inline

create a new typed row, always with default values

◆ NewRowTyped() [2/2]

AProcessedFeeRow Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.NewRowTyped ( bool  AWithDefaultValues)
inline

create a new typed row

◆ RemoveColumnsNotInTableTemplate()

void Ict.Common.Data.TTypedDataTable.RemoveColumnsNotInTableTemplate ( DataTable  ATableTemplate)
inlineinherited

remove columns that are not needed

Parameters
ATableTemplatethis table only contains the columns that should be kept

◆ ResetStaticVariables()

static void Ict.Common.Data.TTypedDataTable.ResetStaticVariables ( )
inlinestaticinherited

reset the static variables for each Web Request call.

Member Data Documentation

◆ ColumnBatchNumber

DataColumn Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.ColumnBatchNumber

Number of the gift batch containing this detail.

◆ ColumnBatchNumberId

readonly short Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.ColumnBatchNumberId = 1
static

used for generic TTypedDataTable functions

◆ ColumnCostCentreCode

DataColumn Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.ColumnCostCentreCode

Cost centre code which the fee will be charged against.

◆ ColumnCostCentreCodeId

readonly short Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.ColumnCostCentreCodeId = 5
static

used for generic TTypedDataTable functions

◆ ColumnCreatedBy

DataColumn Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.ColumnCreatedBy

User ID of who created this record.

◆ ColumnCreatedById

readonly short Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.ColumnCreatedById = 11
static

used for generic TTypedDataTable functions

◆ ColumnDateCreated

DataColumn Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.ColumnDateCreated

The date the record was created.

◆ ColumnDateCreatedId

readonly short Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.ColumnDateCreatedId = 10
static

used for generic TTypedDataTable functions

◆ ColumnDateModified

DataColumn Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.ColumnDateModified

The date the record was modified.

◆ ColumnDateModifiedId

readonly short Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.ColumnDateModifiedId = 12
static

used for generic TTypedDataTable functions

◆ ColumnDetailNumber

DataColumn Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.ColumnDetailNumber

Identifies a gift detail within a gift transaction. When a donor gives a donation to multiple recipients (a split gift), a gift detail record is created for each recipient.

◆ ColumnDetailNumberId

readonly short Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.ColumnDetailNumberId = 3
static

used for generic TTypedDataTable functions

◆ ColumnFeeCode

DataColumn Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.ColumnFeeCode

the fee which the calculated amounts are stored against.

◆ ColumnFeeCodeId

readonly short Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.ColumnFeeCodeId = 4
static

used for generic TTypedDataTable functions

◆ ColumnGiftTransactionNumber

DataColumn Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.ColumnGiftTransactionNumber

Identifies a gift transaction within a gift batch.

◆ ColumnGiftTransactionNumberId

readonly short Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.ColumnGiftTransactionNumberId = 2
static

used for generic TTypedDataTable functions

◆ ColumnLedgerNumber

DataColumn Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.ColumnLedgerNumber

This is used as a key field in most of the accounting system files.

◆ ColumnLedgerNumberId

readonly short Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.ColumnLedgerNumberId = 0
static

used for generic TTypedDataTable functions

◆ ColumnModificationId

DataColumn Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.ColumnModificationId

This identifies the current version of the record.

◆ ColumnModificationIdId

readonly short Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.ColumnModificationIdId = 14
static

used for generic TTypedDataTable functions

◆ ColumnModifiedBy

DataColumn Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.ColumnModifiedBy

User ID of who last modified this record.

◆ ColumnModifiedById

readonly short Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.ColumnModifiedById = 13
static

used for generic TTypedDataTable functions

◆ ColumnPeriodicAmount

DataColumn Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.ColumnPeriodicAmount

Total Amount of the fee for the given period.

◆ ColumnPeriodicAmountId

readonly short Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.ColumnPeriodicAmountId = 7
static

used for generic TTypedDataTable functions

◆ ColumnPeriodNumber

DataColumn Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.ColumnPeriodNumber

Period number.

◆ ColumnPeriodNumberId

readonly short Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.ColumnPeriodNumberId = 6
static

used for generic TTypedDataTable functions

◆ ColumnProcessedDate

DataColumn Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.ColumnProcessedDate

Date ""admin fee calculations"" have been run to fee total has been created as a transaction in the general ledger.

◆ ColumnProcessedDateId

readonly short Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.ColumnProcessedDateId = 8
static

used for generic TTypedDataTable functions

◆ ColumnTimestamp

DataColumn Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.ColumnTimestamp

System generated time stamp.

◆ ColumnTimestampId

readonly short Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.ColumnTimestampId = 9
static

used for generic TTypedDataTable functions

◆ DontThrowAwayAfterSubmitChanges

bool Ict.Common.Data.TTypedDataTable.DontThrowAwayAfterSubmitChanges = false
inherited

if you want no warning about that the datatable should be cleared after submitchanges. in some cases you must keep the data, eg when you need the new keys after INSERT

◆ TableId

readonly short Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.TableId = 149
static

TableId for Ict.Common.Data generic functions.

◆ TableInfo

SortedList<short, TTypedTableInfo> Ict.Common.Data.TTypedDataTable.TableInfo = new SortedList <short, TTypedTableInfo>()
staticprotectedinherited

stores information about typed tables

◆ ThrowAwayAfterSubmitChanges

bool Ict.Common.Data.TTypedDataTable.ThrowAwayAfterSubmitChanges = false
inherited

if you want the datatable to be cleared after submitchanges. This will increase the speed significantly: no updating of modificationID, no slow AcceptChanges.

Property Documentation

◆ Count

int Ict.Common.Data.TTypedDataTable.Count
getinherited

the number of rows in the current table

◆ TableDBLabel

override string Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.TableDBLabel
get

instance property to get the 'Label' of the table as it is used in the database (the 'Label' is usually a short description of what the db table is about)

◆ this[int i]

AProcessedFeeRow Ict.Petra.Shared.MFinance.Gift.Data.AProcessedFeeTable.this[int i]
get

Access a typed row by index.


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