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

Records all payments that have been made against an accounts payable detail. More...

Inheritance diagram for Ict.Petra.Shared.MFinance.AP.Data.AccountsPayableTDSAApPaymentTable:
Ict.Petra.Shared.MFinance.AP.Data.AApPaymentTable Ict.Common.Data.TTypedDataTable

Public Member Functions

 AccountsPayableTDSAApPaymentTable ()
 constructor More...
 
 AccountsPayableTDSAApPaymentTable (string ATablename)
 constructor More...
 
 AccountsPayableTDSAApPaymentTable (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...
 
new AccountsPayableTDSAApPaymentRow NewRowTyped (bool AWithDefaultValues)
 create a new typed row More...
 
new AccountsPayableTDSAApPaymentRow NewRowTyped ()
 create a new typed row, always with default values More...
 
new AccountsPayableTDSAApPaymentTable 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 new string GetTableName ()
 return the CamelCase name of the table More...
 
static new string GetTableDBName ()
 return the name of the table as it is used in the database More...
 
static new 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 GetSupplierKeyDBName ()
 get the name of the field in the database for this column More...
 
static short GetSupplierKeyLength ()
 get character length for column More...
 
static string GetSupplierKeyHelp ()
 get the help text for the field in the database for this column More...
 
static string GetSupplierNameDBName ()
 get the name of the field in the database for this column More...
 
static short GetSupplierNameLength ()
 get character length for column More...
 
static string GetSupplierNameHelp ()
 get the help text for the field in the database for this column More...
 
static string GetListLabelDBName ()
 get the name of the field in the database for this column More...
 
static short GetListLabelLength ()
 get character length for column More...
 
static string GetListLabelHelp ()
 get the help text for the field in the database for this column More...
 
static string GetPrintRemittanceAdviceDBName ()
 get the name of the field in the database for this column More...
 
static short GetPrintRemittanceAdviceLength ()
 get character length for column More...
 
static string GetPrintRemittanceAdviceHelp ()
 get the help text for the field in the database for this column More...
 
static string GetPrintChequeDBName ()
 get the name of the field in the database for this column More...
 
static short GetPrintChequeLength ()
 get character length for column More...
 
static string GetPrintChequeHelp ()
 get the help text for the field in the database for this column More...
 
static string GetChequeNumberDBName ()
 get the name of the field in the database for this column More...
 
static short GetChequeNumberLength ()
 get character length for column More...
 
static string GetChequeNumberHelp ()
 get the help text for the field in the database for this column More...
 
static string GetChequeAmountInWordsDBName ()
 get the name of the field in the database for this column More...
 
static short GetChequeAmountInWordsLength ()
 get character length for column More...
 
static string GetChequeAmountInWordsHelp ()
 get the help text for the field in the database for this column More...
 
static string GetTableName (short ATableNumber)
 the table name in CamelCase 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 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 GetPaymentNumberDBName ()
 get the name of the field in the database for this column More...
 
static short GetPaymentNumberLength ()
 get character length for column More...
 
static string GetPaymentNumberHelp ()
 get the help text for the field in the database for this column More...
 
static string GetAmountDBName ()
 get the name of the field in the database for this column More...
 
static short GetAmountLength ()
 get character length for column More...
 
static string GetAmountHelp ()
 get the help text for the field in the database for this column More...
 
static string GetCurrencyCodeDBName ()
 get the name of the field in the database for this column More...
 
static short GetCurrencyCodeLength ()
 get character length for column More...
 
static string GetCurrencyCodeHelp ()
 get the help text for the field in the database for this column More...
 
static string GetExchangeRateToBaseDBName ()
 get the name of the field in the database for this column More...
 
static short GetExchangeRateToBaseLength ()
 get character length for column More...
 
static string GetExchangeRateToBaseHelp ()
 get the help text for the field in the database for this column More...
 
static string GetPaymentDateDBName ()
 get the name of the field in the database for this column More...
 
static short GetPaymentDateLength ()
 get character length for column More...
 
static string GetPaymentDateHelp ()
 get the help text for the field in the database for this column More...
 
static string GetUserIdDBName ()
 get the name of the field in the database for this column More...
 
static short GetUserIdLength ()
 get character length for column More...
 
static string GetUserIdHelp ()
 get the help text for the field in the database for this column More...
 
static string GetMethodOfPaymentDBName ()
 get the name of the field in the database for this column More...
 
static short GetMethodOfPaymentLength ()
 get character length for column More...
 
static string GetMethodOfPaymentHelp ()
 get the help text for the field in the database for this column More...
 
static string GetReferenceDBName ()
 get the name of the field in the database for this column More...
 
static short GetReferenceLength ()
 get character length for column More...
 
static string GetReferenceHelp ()
 get the help text for the field in the database for this column More...
 
static string GetBankAccountDBName ()
 get the name of the field in the database for this column More...
 
static short GetBankAccountLength ()
 get character length for column More...
 
static string GetBankAccountHelp ()
 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 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 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 ColumnSupplierKey
 
DataColumn ColumnSupplierName
 
DataColumn ColumnListLabel
 
DataColumn ColumnPrintRemittanceAdvice
 
DataColumn ColumnPrintCheque
 
DataColumn ColumnChequeNumber
 
DataColumn ColumnChequeAmountInWords
 
DataColumn ColumnLedgerNumber
 This is used as a key field in most of the accounting system files. More...
 
DataColumn ColumnPaymentNumber
 Unique number to identify each payment batch. More...
 
DataColumn ColumnAmount
 The amount of money that was paid. More...
 
DataColumn ColumnCurrencyCode
 the currency of the document More...
 
DataColumn ColumnExchangeRateToBase
 The exchange rate to the base currency at the time of payment. More...
 
DataColumn ColumnPaymentDate
 Date that the payment for an accounts payable was made. More...
 
DataColumn ColumnUserId
 This is the system user id of the person who made the payment. More...
 
DataColumn ColumnMethodOfPayment
 Method that was used to make the payment - cheque, cash, ep, credit card, etc. More...
 
DataColumn ColumnReference
 The source or reference for the accounts payable payment. This could be a cheque number. More...
 
DataColumn ColumnBankAccount
 Bank account from which to make the payment. 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 new readonly short TableId = 174
 TableId for Ict.Common.Data generic functions. More...
 
static readonly short ColumnSupplierKeyId = 15
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnSupplierNameId = 16
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnListLabelId = 17
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnPrintRemittanceAdviceId = 18
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnPrintChequeId = 19
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnChequeNumberId = 20
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnChequeAmountInWordsId = 21
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnLedgerNumberId = 0
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnPaymentNumberId = 1
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnAmountId = 2
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnCurrencyCodeId = 3
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnExchangeRateToBaseId = 4
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnPaymentDateId = 5
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnUserIdId = 6
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnMethodOfPaymentId = 7
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnReferenceId = 8
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnBankAccountId = 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

new AccountsPayableTDSAApPaymentRow 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

Records all payments that have been made against an accounts payable detail.

Constructor & Destructor Documentation

◆ AccountsPayableTDSAApPaymentTable() [1/3]

Ict.Petra.Shared.MFinance.AP.Data.AccountsPayableTDSAApPaymentTable.AccountsPayableTDSAApPaymentTable ( )
inline

constructor

◆ AccountsPayableTDSAApPaymentTable() [2/3]

Ict.Petra.Shared.MFinance.AP.Data.AccountsPayableTDSAApPaymentTable.AccountsPayableTDSAApPaymentTable ( string  ATablename)
inline

constructor

◆ AccountsPayableTDSAApPaymentTable() [3/3]

Ict.Petra.Shared.MFinance.AP.Data.AccountsPayableTDSAApPaymentTable.AccountsPayableTDSAApPaymentTable ( 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.AP.Data.AccountsPayableTDSAApPaymentTable.CreateOdbcParameter ( Int32  AColumnNr)
inlinevirtual

get an odbc parameter for the given column

Reimplemented from Ict.Petra.Shared.MFinance.AP.Data.AApPaymentTable.

◆ 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

◆ GetAmountDBName()

static string Ict.Petra.Shared.MFinance.AP.Data.AApPaymentTable.GetAmountDBName ( )
inlinestaticinherited

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

◆ GetAmountHelp()

static string Ict.Petra.Shared.MFinance.AP.Data.AApPaymentTable.GetAmountHelp ( )
inlinestaticinherited

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

◆ GetAmountLength()

static short Ict.Petra.Shared.MFinance.AP.Data.AApPaymentTable.GetAmountLength ( )
inlinestaticinherited

get character length for column

◆ GetBankAccountDBName()

static string Ict.Petra.Shared.MFinance.AP.Data.AApPaymentTable.GetBankAccountDBName ( )
inlinestaticinherited

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

◆ GetBankAccountHelp()

static string Ict.Petra.Shared.MFinance.AP.Data.AApPaymentTable.GetBankAccountHelp ( )
inlinestaticinherited

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

◆ GetBankAccountLength()

static short Ict.Petra.Shared.MFinance.AP.Data.AApPaymentTable.GetBankAccountLength ( )
inlinestaticinherited

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()

new AccountsPayableTDSAApPaymentTable Ict.Petra.Shared.MFinance.AP.Data.AccountsPayableTDSAApPaymentTable.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

◆ GetChequeAmountInWordsDBName()

static string Ict.Petra.Shared.MFinance.AP.Data.AccountsPayableTDSAApPaymentTable.GetChequeAmountInWordsDBName ( )
inlinestatic

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

◆ GetChequeAmountInWordsHelp()

static string Ict.Petra.Shared.MFinance.AP.Data.AccountsPayableTDSAApPaymentTable.GetChequeAmountInWordsHelp ( )
inlinestatic

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

◆ GetChequeAmountInWordsLength()

static short Ict.Petra.Shared.MFinance.AP.Data.AccountsPayableTDSAApPaymentTable.GetChequeAmountInWordsLength ( )
inlinestatic

get character length for column

◆ GetChequeNumberDBName()

static string Ict.Petra.Shared.MFinance.AP.Data.AccountsPayableTDSAApPaymentTable.GetChequeNumberDBName ( )
inlinestatic

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

◆ GetChequeNumberHelp()

static string Ict.Petra.Shared.MFinance.AP.Data.AccountsPayableTDSAApPaymentTable.GetChequeNumberHelp ( )
inlinestatic

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

◆ GetChequeNumberLength()

static short Ict.Petra.Shared.MFinance.AP.Data.AccountsPayableTDSAApPaymentTable.GetChequeNumberLength ( )
inlinestatic

get character length for column

◆ 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

◆ GetCreatedByDBName()

static string Ict.Petra.Shared.MFinance.AP.Data.AApPaymentTable.GetCreatedByDBName ( )
inlinestaticinherited

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

◆ GetCreatedByHelp()

static string Ict.Petra.Shared.MFinance.AP.Data.AApPaymentTable.GetCreatedByHelp ( )
inlinestaticinherited

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

◆ GetCreatedByLength()

static short Ict.Petra.Shared.MFinance.AP.Data.AApPaymentTable.GetCreatedByLength ( )
inlinestaticinherited

get character length for column

◆ GetCurrencyCodeDBName()

static string Ict.Petra.Shared.MFinance.AP.Data.AApPaymentTable.GetCurrencyCodeDBName ( )
inlinestaticinherited

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

◆ GetCurrencyCodeHelp()

static string Ict.Petra.Shared.MFinance.AP.Data.AApPaymentTable.GetCurrencyCodeHelp ( )
inlinestaticinherited

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

◆ GetCurrencyCodeLength()

static short Ict.Petra.Shared.MFinance.AP.Data.AApPaymentTable.GetCurrencyCodeLength ( )
inlinestaticinherited

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.AP.Data.AApPaymentTable.GetDateCreatedDBName ( )
inlinestaticinherited

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

◆ GetDateCreatedHelp()

static string Ict.Petra.Shared.MFinance.AP.Data.AApPaymentTable.GetDateCreatedHelp ( )
inlinestaticinherited

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

◆ GetDateCreatedLength()

static short Ict.Petra.Shared.MFinance.AP.Data.AApPaymentTable.GetDateCreatedLength ( )
inlinestaticinherited

get character length for column

◆ GetDateModifiedDBName()

static string Ict.Petra.Shared.MFinance.AP.Data.AApPaymentTable.GetDateModifiedDBName ( )
inlinestaticinherited

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

◆ GetDateModifiedHelp()

static string Ict.Petra.Shared.MFinance.AP.Data.AApPaymentTable.GetDateModifiedHelp ( )
inlinestaticinherited

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

◆ GetDateModifiedLength()

static short Ict.Petra.Shared.MFinance.AP.Data.AApPaymentTable.GetDateModifiedLength ( )
inlinestaticinherited

get character length for column

◆ GetExchangeRateToBaseDBName()

static string Ict.Petra.Shared.MFinance.AP.Data.AApPaymentTable.GetExchangeRateToBaseDBName ( )
inlinestaticinherited

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

◆ GetExchangeRateToBaseHelp()

static string Ict.Petra.Shared.MFinance.AP.Data.AApPaymentTable.GetExchangeRateToBaseHelp ( )
inlinestaticinherited

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

◆ GetExchangeRateToBaseLength()

static short Ict.Petra.Shared.MFinance.AP.Data.AApPaymentTable.GetExchangeRateToBaseLength ( )
inlinestaticinherited

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.AP.Data.AApPaymentTable.GetLedgerNumberDBName ( )
inlinestaticinherited

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

◆ GetLedgerNumberHelp()

static string Ict.Petra.Shared.MFinance.AP.Data.AApPaymentTable.GetLedgerNumberHelp ( )
inlinestaticinherited

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

◆ GetLedgerNumberLength()

static short Ict.Petra.Shared.MFinance.AP.Data.AApPaymentTable.GetLedgerNumberLength ( )
inlinestaticinherited

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

◆ GetListLabelDBName()

static string Ict.Petra.Shared.MFinance.AP.Data.AccountsPayableTDSAApPaymentTable.GetListLabelDBName ( )
inlinestatic

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

◆ GetListLabelHelp()

static string Ict.Petra.Shared.MFinance.AP.Data.AccountsPayableTDSAApPaymentTable.GetListLabelHelp ( )
inlinestatic

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

◆ GetListLabelLength()

static short Ict.Petra.Shared.MFinance.AP.Data.AccountsPayableTDSAApPaymentTable.GetListLabelLength ( )
inlinestatic

get character length for column

◆ GetMethodOfPaymentDBName()

static string Ict.Petra.Shared.MFinance.AP.Data.AApPaymentTable.GetMethodOfPaymentDBName ( )
inlinestaticinherited

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

◆ GetMethodOfPaymentHelp()

static string Ict.Petra.Shared.MFinance.AP.Data.AApPaymentTable.GetMethodOfPaymentHelp ( )
inlinestaticinherited

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

◆ GetMethodOfPaymentLength()

static short Ict.Petra.Shared.MFinance.AP.Data.AApPaymentTable.GetMethodOfPaymentLength ( )
inlinestaticinherited

get character length for column

◆ GetModificationIdDBName()

static string Ict.Petra.Shared.MFinance.AP.Data.AApPaymentTable.GetModificationIdDBName ( )
inlinestaticinherited

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

◆ GetModificationIdHelp()

static string Ict.Petra.Shared.MFinance.AP.Data.AApPaymentTable.GetModificationIdHelp ( )
inlinestaticinherited

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

◆ GetModificationIdLength()

static short Ict.Petra.Shared.MFinance.AP.Data.AApPaymentTable.GetModificationIdLength ( )
inlinestaticinherited

get character length for column

◆ GetModifiedByDBName()

static string Ict.Petra.Shared.MFinance.AP.Data.AApPaymentTable.GetModifiedByDBName ( )
inlinestaticinherited

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

◆ GetModifiedByHelp()

static string Ict.Petra.Shared.MFinance.AP.Data.AApPaymentTable.GetModifiedByHelp ( )
inlinestaticinherited

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

◆ GetModifiedByLength()

static short Ict.Petra.Shared.MFinance.AP.Data.AApPaymentTable.GetModifiedByLength ( )
inlinestaticinherited

get character length for column

◆ GetPaymentDateDBName()

static string Ict.Petra.Shared.MFinance.AP.Data.AApPaymentTable.GetPaymentDateDBName ( )
inlinestaticinherited

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

◆ GetPaymentDateHelp()

static string Ict.Petra.Shared.MFinance.AP.Data.AApPaymentTable.GetPaymentDateHelp ( )
inlinestaticinherited

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

◆ GetPaymentDateLength()

static short Ict.Petra.Shared.MFinance.AP.Data.AApPaymentTable.GetPaymentDateLength ( )
inlinestaticinherited

get character length for column

◆ GetPaymentNumberDBName()

static string Ict.Petra.Shared.MFinance.AP.Data.AApPaymentTable.GetPaymentNumberDBName ( )
inlinestaticinherited

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

◆ GetPaymentNumberHelp()

static string Ict.Petra.Shared.MFinance.AP.Data.AApPaymentTable.GetPaymentNumberHelp ( )
inlinestaticinherited

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

◆ GetPaymentNumberLength()

static short Ict.Petra.Shared.MFinance.AP.Data.AApPaymentTable.GetPaymentNumberLength ( )
inlinestaticinherited

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

◆ GetPrintChequeDBName()

static string Ict.Petra.Shared.MFinance.AP.Data.AccountsPayableTDSAApPaymentTable.GetPrintChequeDBName ( )
inlinestatic

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

◆ GetPrintChequeHelp()

static string Ict.Petra.Shared.MFinance.AP.Data.AccountsPayableTDSAApPaymentTable.GetPrintChequeHelp ( )
inlinestatic

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

◆ GetPrintChequeLength()

static short Ict.Petra.Shared.MFinance.AP.Data.AccountsPayableTDSAApPaymentTable.GetPrintChequeLength ( )
inlinestatic

get character length for column

◆ GetPrintRemittanceAdviceDBName()

static string Ict.Petra.Shared.MFinance.AP.Data.AccountsPayableTDSAApPaymentTable.GetPrintRemittanceAdviceDBName ( )
inlinestatic

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

◆ GetPrintRemittanceAdviceHelp()

static string Ict.Petra.Shared.MFinance.AP.Data.AccountsPayableTDSAApPaymentTable.GetPrintRemittanceAdviceHelp ( )
inlinestatic

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

◆ GetPrintRemittanceAdviceLength()

static short Ict.Petra.Shared.MFinance.AP.Data.AccountsPayableTDSAApPaymentTable.GetPrintRemittanceAdviceLength ( )
inlinestatic

get character length for column

◆ GetReferenceDBName()

static string Ict.Petra.Shared.MFinance.AP.Data.AApPaymentTable.GetReferenceDBName ( )
inlinestaticinherited

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

◆ GetReferenceHelp()

static string Ict.Petra.Shared.MFinance.AP.Data.AApPaymentTable.GetReferenceHelp ( )
inlinestaticinherited

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

◆ GetReferenceLength()

static short Ict.Petra.Shared.MFinance.AP.Data.AApPaymentTable.GetReferenceLength ( )
inlinestaticinherited

get character length for column

◆ GetSupplierKeyDBName()

static string Ict.Petra.Shared.MFinance.AP.Data.AccountsPayableTDSAApPaymentTable.GetSupplierKeyDBName ( )
inlinestatic

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

◆ GetSupplierKeyHelp()

static string Ict.Petra.Shared.MFinance.AP.Data.AccountsPayableTDSAApPaymentTable.GetSupplierKeyHelp ( )
inlinestatic

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

◆ GetSupplierKeyLength()

static short Ict.Petra.Shared.MFinance.AP.Data.AccountsPayableTDSAApPaymentTable.GetSupplierKeyLength ( )
inlinestatic

get character length for column

◆ GetSupplierNameDBName()

static string Ict.Petra.Shared.MFinance.AP.Data.AccountsPayableTDSAApPaymentTable.GetSupplierNameDBName ( )
inlinestatic

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

◆ GetSupplierNameHelp()

static string Ict.Petra.Shared.MFinance.AP.Data.AccountsPayableTDSAApPaymentTable.GetSupplierNameHelp ( )
inlinestatic

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

◆ GetSupplierNameLength()

static short Ict.Petra.Shared.MFinance.AP.Data.AccountsPayableTDSAApPaymentTable.GetSupplierNameLength ( )
inlinestatic

get character length for column

◆ GetTableByName()

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

the table name in CamelCase

◆ GetTableDBLabel()

static new string Ict.Petra.Shared.MFinance.AP.Data.AccountsPayableTDSAApPaymentTable.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 new string Ict.Petra.Shared.MFinance.AP.Data.AccountsPayableTDSAApPaymentTable.GetTableDBName ( )
inlinestatic

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

◆ GetTableName() [1/2]

static new string Ict.Petra.Shared.MFinance.AP.Data.AccountsPayableTDSAApPaymentTable.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

◆ 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

◆ GetUserIdDBName()

static string Ict.Petra.Shared.MFinance.AP.Data.AApPaymentTable.GetUserIdDBName ( )
inlinestaticinherited

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

◆ GetUserIdHelp()

static string Ict.Petra.Shared.MFinance.AP.Data.AApPaymentTable.GetUserIdHelp ( )
inlinestaticinherited

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

◆ GetUserIdLength()

static short Ict.Petra.Shared.MFinance.AP.Data.AApPaymentTable.GetUserIdLength ( )
inlinestaticinherited

get character length for column

◆ InitClass()

override void Ict.Petra.Shared.MFinance.AP.Data.AccountsPayableTDSAApPaymentTable.InitClass ( )
inlineprotectedvirtual

create the columns

Reimplemented from Ict.Petra.Shared.MFinance.AP.Data.AApPaymentTable.

◆ InitVars()

override void Ict.Petra.Shared.MFinance.AP.Data.AccountsPayableTDSAApPaymentTable.InitVars ( )
inlinevirtual

assign columns to properties, set primary key

Reimplemented from Ict.Petra.Shared.MFinance.AP.Data.AApPaymentTable.

◆ 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.AP.Data.AccountsPayableTDSAApPaymentTable.NewRowFromBuilder ( System.Data.DataRowBuilder  builder)
inlineprotected

new typed row using DataRowBuilder

◆ NewRowTyped() [1/2]

new AccountsPayableTDSAApPaymentRow Ict.Petra.Shared.MFinance.AP.Data.AccountsPayableTDSAApPaymentTable.NewRowTyped ( )
inline

create a new typed row, always with default values

◆ NewRowTyped() [2/2]

new AccountsPayableTDSAApPaymentRow Ict.Petra.Shared.MFinance.AP.Data.AccountsPayableTDSAApPaymentTable.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

◆ ColumnAmount

DataColumn Ict.Petra.Shared.MFinance.AP.Data.AApPaymentTable.ColumnAmount
inherited

The amount of money that was paid.

◆ ColumnAmountId

readonly short Ict.Petra.Shared.MFinance.AP.Data.AApPaymentTable.ColumnAmountId = 2
staticinherited

used for generic TTypedDataTable functions

◆ ColumnBankAccount

DataColumn Ict.Petra.Shared.MFinance.AP.Data.AApPaymentTable.ColumnBankAccount
inherited

Bank account from which to make the payment.

◆ ColumnBankAccountId

readonly short Ict.Petra.Shared.MFinance.AP.Data.AApPaymentTable.ColumnBankAccountId = 9
staticinherited

used for generic TTypedDataTable functions

◆ ColumnChequeAmountInWords

DataColumn Ict.Petra.Shared.MFinance.AP.Data.AccountsPayableTDSAApPaymentTable.ColumnChequeAmountInWords

◆ ColumnChequeAmountInWordsId

readonly short Ict.Petra.Shared.MFinance.AP.Data.AccountsPayableTDSAApPaymentTable.ColumnChequeAmountInWordsId = 21
static

used for generic TTypedDataTable functions

◆ ColumnChequeNumber

DataColumn Ict.Petra.Shared.MFinance.AP.Data.AccountsPayableTDSAApPaymentTable.ColumnChequeNumber

◆ ColumnChequeNumberId

readonly short Ict.Petra.Shared.MFinance.AP.Data.AccountsPayableTDSAApPaymentTable.ColumnChequeNumberId = 20
static

used for generic TTypedDataTable functions

◆ ColumnCreatedBy

DataColumn Ict.Petra.Shared.MFinance.AP.Data.AApPaymentTable.ColumnCreatedBy
inherited

User ID of who created this record.

◆ ColumnCreatedById

readonly short Ict.Petra.Shared.MFinance.AP.Data.AApPaymentTable.ColumnCreatedById = 11
staticinherited

used for generic TTypedDataTable functions

◆ ColumnCurrencyCode

DataColumn Ict.Petra.Shared.MFinance.AP.Data.AApPaymentTable.ColumnCurrencyCode
inherited

the currency of the document

◆ ColumnCurrencyCodeId

readonly short Ict.Petra.Shared.MFinance.AP.Data.AApPaymentTable.ColumnCurrencyCodeId = 3
staticinherited

used for generic TTypedDataTable functions

◆ ColumnDateCreated

DataColumn Ict.Petra.Shared.MFinance.AP.Data.AApPaymentTable.ColumnDateCreated
inherited

The date the record was created.

◆ ColumnDateCreatedId

readonly short Ict.Petra.Shared.MFinance.AP.Data.AApPaymentTable.ColumnDateCreatedId = 10
staticinherited

used for generic TTypedDataTable functions

◆ ColumnDateModified

DataColumn Ict.Petra.Shared.MFinance.AP.Data.AApPaymentTable.ColumnDateModified
inherited

The date the record was modified.

◆ ColumnDateModifiedId

readonly short Ict.Petra.Shared.MFinance.AP.Data.AApPaymentTable.ColumnDateModifiedId = 12
staticinherited

used for generic TTypedDataTable functions

◆ ColumnExchangeRateToBase

DataColumn Ict.Petra.Shared.MFinance.AP.Data.AApPaymentTable.ColumnExchangeRateToBase
inherited

The exchange rate to the base currency at the time of payment.

◆ ColumnExchangeRateToBaseId

readonly short Ict.Petra.Shared.MFinance.AP.Data.AApPaymentTable.ColumnExchangeRateToBaseId = 4
staticinherited

used for generic TTypedDataTable functions

◆ ColumnLedgerNumber

DataColumn Ict.Petra.Shared.MFinance.AP.Data.AApPaymentTable.ColumnLedgerNumber
inherited

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

◆ ColumnLedgerNumberId

readonly short Ict.Petra.Shared.MFinance.AP.Data.AApPaymentTable.ColumnLedgerNumberId = 0
staticinherited

used for generic TTypedDataTable functions

◆ ColumnListLabel

DataColumn Ict.Petra.Shared.MFinance.AP.Data.AccountsPayableTDSAApPaymentTable.ColumnListLabel

◆ ColumnListLabelId

readonly short Ict.Petra.Shared.MFinance.AP.Data.AccountsPayableTDSAApPaymentTable.ColumnListLabelId = 17
static

used for generic TTypedDataTable functions

◆ ColumnMethodOfPayment

DataColumn Ict.Petra.Shared.MFinance.AP.Data.AApPaymentTable.ColumnMethodOfPayment
inherited

Method that was used to make the payment - cheque, cash, ep, credit card, etc.

◆ ColumnMethodOfPaymentId

readonly short Ict.Petra.Shared.MFinance.AP.Data.AApPaymentTable.ColumnMethodOfPaymentId = 7
staticinherited

used for generic TTypedDataTable functions

◆ ColumnModificationId

DataColumn Ict.Petra.Shared.MFinance.AP.Data.AApPaymentTable.ColumnModificationId
inherited

This identifies the current version of the record.

◆ ColumnModificationIdId

readonly short Ict.Petra.Shared.MFinance.AP.Data.AApPaymentTable.ColumnModificationIdId = 14
staticinherited

used for generic TTypedDataTable functions

◆ ColumnModifiedBy

DataColumn Ict.Petra.Shared.MFinance.AP.Data.AApPaymentTable.ColumnModifiedBy
inherited

User ID of who last modified this record.

◆ ColumnModifiedById

readonly short Ict.Petra.Shared.MFinance.AP.Data.AApPaymentTable.ColumnModifiedById = 13
staticinherited

used for generic TTypedDataTable functions

◆ ColumnPaymentDate

DataColumn Ict.Petra.Shared.MFinance.AP.Data.AApPaymentTable.ColumnPaymentDate
inherited

Date that the payment for an accounts payable was made.

◆ ColumnPaymentDateId

readonly short Ict.Petra.Shared.MFinance.AP.Data.AApPaymentTable.ColumnPaymentDateId = 5
staticinherited

used for generic TTypedDataTable functions

◆ ColumnPaymentNumber

DataColumn Ict.Petra.Shared.MFinance.AP.Data.AApPaymentTable.ColumnPaymentNumber
inherited

Unique number to identify each payment batch.

◆ ColumnPaymentNumberId

readonly short Ict.Petra.Shared.MFinance.AP.Data.AApPaymentTable.ColumnPaymentNumberId = 1
staticinherited

used for generic TTypedDataTable functions

◆ ColumnPrintCheque

DataColumn Ict.Petra.Shared.MFinance.AP.Data.AccountsPayableTDSAApPaymentTable.ColumnPrintCheque

◆ ColumnPrintChequeId

readonly short Ict.Petra.Shared.MFinance.AP.Data.AccountsPayableTDSAApPaymentTable.ColumnPrintChequeId = 19
static

used for generic TTypedDataTable functions

◆ ColumnPrintRemittanceAdvice

DataColumn Ict.Petra.Shared.MFinance.AP.Data.AccountsPayableTDSAApPaymentTable.ColumnPrintRemittanceAdvice

◆ ColumnPrintRemittanceAdviceId

readonly short Ict.Petra.Shared.MFinance.AP.Data.AccountsPayableTDSAApPaymentTable.ColumnPrintRemittanceAdviceId = 18
static

used for generic TTypedDataTable functions

◆ ColumnReference

DataColumn Ict.Petra.Shared.MFinance.AP.Data.AApPaymentTable.ColumnReference
inherited

The source or reference for the accounts payable payment. This could be a cheque number.

◆ ColumnReferenceId

readonly short Ict.Petra.Shared.MFinance.AP.Data.AApPaymentTable.ColumnReferenceId = 8
staticinherited

used for generic TTypedDataTable functions

◆ ColumnSupplierKey

DataColumn Ict.Petra.Shared.MFinance.AP.Data.AccountsPayableTDSAApPaymentTable.ColumnSupplierKey

◆ ColumnSupplierKeyId

readonly short Ict.Petra.Shared.MFinance.AP.Data.AccountsPayableTDSAApPaymentTable.ColumnSupplierKeyId = 15
static

used for generic TTypedDataTable functions

◆ ColumnSupplierName

DataColumn Ict.Petra.Shared.MFinance.AP.Data.AccountsPayableTDSAApPaymentTable.ColumnSupplierName

◆ ColumnSupplierNameId

readonly short Ict.Petra.Shared.MFinance.AP.Data.AccountsPayableTDSAApPaymentTable.ColumnSupplierNameId = 16
static

used for generic TTypedDataTable functions

◆ ColumnUserId

DataColumn Ict.Petra.Shared.MFinance.AP.Data.AApPaymentTable.ColumnUserId
inherited

This is the system user id of the person who made the payment.

◆ ColumnUserIdId

readonly short Ict.Petra.Shared.MFinance.AP.Data.AApPaymentTable.ColumnUserIdId = 6
staticinherited

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

new readonly short Ict.Petra.Shared.MFinance.AP.Data.AccountsPayableTDSAApPaymentTable.TableId = 174
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.AP.Data.AccountsPayableTDSAApPaymentTable.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]

new AccountsPayableTDSAApPaymentRow Ict.Petra.Shared.MFinance.AP.Data.AccountsPayableTDSAApPaymentTable.this[int i]
get

Access a typed row by index.


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