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

Templates of general ledger batches which can be copied into the ledger. More...

Inheritance diagram for Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable:
Ict.Common.Data.TTypedDataTable

Public Member Functions

 ARecurringBatchTable ()
 constructor More...
 
 ARecurringBatchTable (string ATablename)
 constructor More...
 
 ARecurringBatchTable (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...
 
ARecurringBatchRow NewRowTyped (bool AWithDefaultValues)
 create a new typed row More...
 
ARecurringBatchRow NewRowTyped ()
 create a new typed row, always with default values More...
 
ARecurringBatchTable 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 GetBatchDescriptionDBName ()
 get the name of the field in the database for this column More...
 
static short GetBatchDescriptionLength ()
 get character length for column More...
 
static string GetBatchDescriptionHelp ()
 get the help text for the field in the database for this column More...
 
static string GetBatchControlTotalDBName ()
 get the name of the field in the database for this column More...
 
static short GetBatchControlTotalLength ()
 get character length for column More...
 
static string GetBatchControlTotalHelp ()
 get the help text for the field in the database for this column More...
 
static string GetBatchStatusDBName ()
 get the name of the field in the database for this column More...
 
static short GetBatchStatusLength ()
 get character length for column More...
 
static string GetBatchStatusHelp ()
 get the help text for the field in the database for this column More...
 
static string GetBatchRunningTotalDBName ()
 get the name of the field in the database for this column More...
 
static short GetBatchRunningTotalLength ()
 get character length for column More...
 
static string GetBatchRunningTotalHelp ()
 get the help text for the field in the database for this column More...
 
static string GetBatchDebitTotalDBName ()
 get the name of the field in the database for this column More...
 
static short GetBatchDebitTotalLength ()
 get character length for column More...
 
static string GetBatchDebitTotalHelp ()
 get the help text for the field in the database for this column More...
 
static string GetBatchCreditTotalDBName ()
 get the name of the field in the database for this column More...
 
static short GetBatchCreditTotalLength ()
 get character length for column More...
 
static string GetBatchCreditTotalHelp ()
 get the help text for the field in the database for this column More...
 
static string GetBatchPeriodDBName ()
 get the name of the field in the database for this column More...
 
static short GetBatchPeriodLength ()
 get character length for column More...
 
static string GetBatchPeriodHelp ()
 get the help text for the field in the database for this column More...
 
static string GetDateEffectiveDBName ()
 get the name of the field in the database for this column More...
 
static short GetDateEffectiveLength ()
 get character length for column More...
 
static string GetDateEffectiveHelp ()
 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 GetDateOfEntryDBName ()
 get the name of the field in the database for this column More...
 
static short GetDateOfEntryLength ()
 get character length for column More...
 
static string GetDateOfEntryHelp ()
 get the help text for the field in the database for this column More...
 
static string GetFrequencyCodeDBName ()
 get the name of the field in the database for this column More...
 
static short GetFrequencyCodeLength ()
 get character length for column More...
 
static string GetFrequencyCodeHelp ()
 get the help text for the field in the database for this column More...
 
static string GetDateBatchLastRunDBName ()
 get the name of the field in the database for this column More...
 
static short GetDateBatchLastRunLength ()
 get character length for column More...
 
static string GetDateBatchLastRunHelp ()
 get the help text for the field in the database for this column More...
 
static string GetLastJournalDBName ()
 get the name of the field in the database for this column More...
 
static short GetLastJournalLength ()
 get character length for column More...
 
static string GetLastJournalHelp ()
 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
 identifes which batch a transaction belongs to More...
 
DataColumn ColumnBatchDescription
 This is a long description and is 80 characters long. More...
 
DataColumn ColumnBatchControlTotal
 This is a number of currency units. More...
 
DataColumn ColumnBatchStatus
 identifies the status of a batch More...
 
DataColumn ColumnBatchRunningTotal
 This is a number of currency units. More...
 
DataColumn ColumnBatchDebitTotal
 This is a number of currency units. More...
 
DataColumn ColumnBatchCreditTotal
 This is a number of currency units. More...
 
DataColumn ColumnBatchPeriod
 This defines which accounting period is being used. More...
 
DataColumn ColumnDateEffective
 Date the batch comes into effect. More...
 
DataColumn ColumnUserId
 This identifies who the current user is. More...
 
DataColumn ColumnDateOfEntry
 
DataColumn ColumnFrequencyCode
 
DataColumn ColumnDateBatchLastRun
 
DataColumn ColumnLastJournal
 Identifies a journal within a batch. 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 = 151
 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 ColumnBatchDescriptionId = 2
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnBatchControlTotalId = 3
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnBatchStatusId = 4
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnBatchRunningTotalId = 5
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnBatchDebitTotalId = 6
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnBatchCreditTotalId = 7
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnBatchPeriodId = 8
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnDateEffectiveId = 9
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnUserIdId = 10
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnDateOfEntryId = 11
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnFrequencyCodeId = 12
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnDateBatchLastRunId = 13
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnLastJournalId = 14
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnDateCreatedId = 15
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnCreatedById = 16
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnDateModifiedId = 17
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnModifiedById = 18
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnModificationIdId = 19
 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

ARecurringBatchRow 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

Templates of general ledger batches which can be copied into the ledger.

Constructor & Destructor Documentation

◆ ARecurringBatchTable() [1/3]

Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.ARecurringBatchTable ( )
inline

constructor

◆ ARecurringBatchTable() [2/3]

Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.ARecurringBatchTable ( string  ATablename)
inline

constructor

◆ ARecurringBatchTable() [3/3]

Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.ARecurringBatchTable ( 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.Account.Data.ARecurringBatchTable.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

◆ GetBatchControlTotalDBName()

static string Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.GetBatchControlTotalDBName ( )
inlinestatic

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

◆ GetBatchControlTotalHelp()

static string Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.GetBatchControlTotalHelp ( )
inlinestatic

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

◆ GetBatchControlTotalLength()

static short Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.GetBatchControlTotalLength ( )
inlinestatic

get character length for column

◆ GetBatchCreditTotalDBName()

static string Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.GetBatchCreditTotalDBName ( )
inlinestatic

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

◆ GetBatchCreditTotalHelp()

static string Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.GetBatchCreditTotalHelp ( )
inlinestatic

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

◆ GetBatchCreditTotalLength()

static short Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.GetBatchCreditTotalLength ( )
inlinestatic

get character length for column

◆ GetBatchDebitTotalDBName()

static string Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.GetBatchDebitTotalDBName ( )
inlinestatic

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

◆ GetBatchDebitTotalHelp()

static string Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.GetBatchDebitTotalHelp ( )
inlinestatic

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

◆ GetBatchDebitTotalLength()

static short Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.GetBatchDebitTotalLength ( )
inlinestatic

get character length for column

◆ GetBatchDescriptionDBName()

static string Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.GetBatchDescriptionDBName ( )
inlinestatic

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

◆ GetBatchDescriptionHelp()

static string Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.GetBatchDescriptionHelp ( )
inlinestatic

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

◆ GetBatchDescriptionLength()

static short Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.GetBatchDescriptionLength ( )
inlinestatic

get character length for column

◆ GetBatchNumberDBName()

static string Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.GetBatchNumberDBName ( )
inlinestatic

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

◆ GetBatchNumberHelp()

static string Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.GetBatchNumberHelp ( )
inlinestatic

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

◆ GetBatchNumberLength()

static short Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.GetBatchNumberLength ( )
inlinestatic

get character length for column

◆ GetBatchPeriodDBName()

static string Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.GetBatchPeriodDBName ( )
inlinestatic

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

◆ GetBatchPeriodHelp()

static string Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.GetBatchPeriodHelp ( )
inlinestatic

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

◆ GetBatchPeriodLength()

static short Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.GetBatchPeriodLength ( )
inlinestatic

get character length for column

◆ GetBatchRunningTotalDBName()

static string Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.GetBatchRunningTotalDBName ( )
inlinestatic

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

◆ GetBatchRunningTotalHelp()

static string Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.GetBatchRunningTotalHelp ( )
inlinestatic

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

◆ GetBatchRunningTotalLength()

static short Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.GetBatchRunningTotalLength ( )
inlinestatic

get character length for column

◆ GetBatchStatusDBName()

static string Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.GetBatchStatusDBName ( )
inlinestatic

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

◆ GetBatchStatusHelp()

static string Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.GetBatchStatusHelp ( )
inlinestatic

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

◆ GetBatchStatusLength()

static short Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.GetBatchStatusLength ( )
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()

ARecurringBatchTable Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.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

◆ GetCreatedByDBName()

static string Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.GetCreatedByDBName ( )
inlinestatic

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

◆ GetCreatedByHelp()

static string Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.GetCreatedByHelp ( )
inlinestatic

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

◆ GetCreatedByLength()

static short Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.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

◆ GetDateBatchLastRunDBName()

static string Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.GetDateBatchLastRunDBName ( )
inlinestatic

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

◆ GetDateBatchLastRunHelp()

static string Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.GetDateBatchLastRunHelp ( )
inlinestatic

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

◆ GetDateBatchLastRunLength()

static short Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.GetDateBatchLastRunLength ( )
inlinestatic

get character length for column

◆ GetDateCreatedDBName()

static string Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.GetDateCreatedDBName ( )
inlinestatic

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

◆ GetDateCreatedHelp()

static string Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.GetDateCreatedHelp ( )
inlinestatic

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

◆ GetDateCreatedLength()

static short Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.GetDateCreatedLength ( )
inlinestatic

get character length for column

◆ GetDateEffectiveDBName()

static string Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.GetDateEffectiveDBName ( )
inlinestatic

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

◆ GetDateEffectiveHelp()

static string Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.GetDateEffectiveHelp ( )
inlinestatic

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

◆ GetDateEffectiveLength()

static short Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.GetDateEffectiveLength ( )
inlinestatic

get character length for column

◆ GetDateModifiedDBName()

static string Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.GetDateModifiedDBName ( )
inlinestatic

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

◆ GetDateModifiedHelp()

static string Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.GetDateModifiedHelp ( )
inlinestatic

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

◆ GetDateModifiedLength()

static short Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.GetDateModifiedLength ( )
inlinestatic

get character length for column

◆ GetDateOfEntryDBName()

static string Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.GetDateOfEntryDBName ( )
inlinestatic

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

◆ GetDateOfEntryHelp()

static string Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.GetDateOfEntryHelp ( )
inlinestatic

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

◆ GetDateOfEntryLength()

static short Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.GetDateOfEntryLength ( )
inlinestatic

get character length for column

◆ GetFrequencyCodeDBName()

static string Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.GetFrequencyCodeDBName ( )
inlinestatic

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

◆ GetFrequencyCodeHelp()

static string Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.GetFrequencyCodeHelp ( )
inlinestatic

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

◆ GetFrequencyCodeLength()

static short Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.GetFrequencyCodeLength ( )
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

◆ GetLastJournalDBName()

static string Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.GetLastJournalDBName ( )
inlinestatic

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

◆ GetLastJournalHelp()

static string Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.GetLastJournalHelp ( )
inlinestatic

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

◆ GetLastJournalLength()

static short Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.GetLastJournalLength ( )
inlinestatic

get character length for column

◆ GetLedgerNumberDBName()

static string Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.GetLedgerNumberDBName ( )
inlinestatic

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

◆ GetLedgerNumberHelp()

static string Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.GetLedgerNumberHelp ( )
inlinestatic

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

◆ GetLedgerNumberLength()

static short Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.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.Account.Data.ARecurringBatchTable.GetModificationIdDBName ( )
inlinestatic

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

◆ GetModificationIdHelp()

static string Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.GetModificationIdHelp ( )
inlinestatic

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

◆ GetModificationIdLength()

static short Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.GetModificationIdLength ( )
inlinestatic

get character length for column

◆ GetModifiedByDBName()

static string Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.GetModifiedByDBName ( )
inlinestatic

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

◆ GetModifiedByHelp()

static string Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.GetModifiedByHelp ( )
inlinestatic

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

◆ GetModifiedByLength()

static short Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.GetModifiedByLength ( )
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

◆ GetTableByName()

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

the table name in CamelCase

◆ GetTableDBLabel()

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

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

◆ GetTableName() [1/2]

static string Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.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.Account.Data.ARecurringBatchTable.GetUserIdDBName ( )
inlinestatic

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

◆ GetUserIdHelp()

static string Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.GetUserIdHelp ( )
inlinestatic

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

◆ GetUserIdLength()

static short Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.GetUserIdLength ( )
inlinestatic

get character length for column

◆ InitClass()

override void Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.InitClass ( )
inlineprotectedvirtual

create the columns

Implements Ict.Common.Data.TTypedDataTable.

◆ InitVars()

override void Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.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.Account.Data.ARecurringBatchTable.NewRowFromBuilder ( System.Data.DataRowBuilder  builder)
inlineprotected

new typed row using DataRowBuilder

◆ NewRowTyped() [1/2]

ARecurringBatchRow Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.NewRowTyped ( )
inline

create a new typed row, always with default values

◆ NewRowTyped() [2/2]

ARecurringBatchRow Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.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

◆ ColumnBatchControlTotal

DataColumn Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.ColumnBatchControlTotal

This is a number of currency units.

◆ ColumnBatchControlTotalId

readonly short Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.ColumnBatchControlTotalId = 3
static

used for generic TTypedDataTable functions

◆ ColumnBatchCreditTotal

DataColumn Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.ColumnBatchCreditTotal

This is a number of currency units.

◆ ColumnBatchCreditTotalId

readonly short Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.ColumnBatchCreditTotalId = 7
static

used for generic TTypedDataTable functions

◆ ColumnBatchDebitTotal

DataColumn Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.ColumnBatchDebitTotal

This is a number of currency units.

◆ ColumnBatchDebitTotalId

readonly short Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.ColumnBatchDebitTotalId = 6
static

used for generic TTypedDataTable functions

◆ ColumnBatchDescription

DataColumn Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.ColumnBatchDescription

This is a long description and is 80 characters long.

◆ ColumnBatchDescriptionId

readonly short Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.ColumnBatchDescriptionId = 2
static

used for generic TTypedDataTable functions

◆ ColumnBatchNumber

DataColumn Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.ColumnBatchNumber

identifes which batch a transaction belongs to

◆ ColumnBatchNumberId

readonly short Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.ColumnBatchNumberId = 1
static

used for generic TTypedDataTable functions

◆ ColumnBatchPeriod

DataColumn Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.ColumnBatchPeriod

This defines which accounting period is being used.

◆ ColumnBatchPeriodId

readonly short Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.ColumnBatchPeriodId = 8
static

used for generic TTypedDataTable functions

◆ ColumnBatchRunningTotal

DataColumn Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.ColumnBatchRunningTotal

This is a number of currency units.

◆ ColumnBatchRunningTotalId

readonly short Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.ColumnBatchRunningTotalId = 5
static

used for generic TTypedDataTable functions

◆ ColumnBatchStatus

DataColumn Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.ColumnBatchStatus

identifies the status of a batch

◆ ColumnBatchStatusId

readonly short Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.ColumnBatchStatusId = 4
static

used for generic TTypedDataTable functions

◆ ColumnCreatedBy

DataColumn Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.ColumnCreatedBy

User ID of who created this record.

◆ ColumnCreatedById

readonly short Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.ColumnCreatedById = 16
static

used for generic TTypedDataTable functions

◆ ColumnDateBatchLastRun

DataColumn Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.ColumnDateBatchLastRun

◆ ColumnDateBatchLastRunId

readonly short Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.ColumnDateBatchLastRunId = 13
static

used for generic TTypedDataTable functions

◆ ColumnDateCreated

DataColumn Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.ColumnDateCreated

The date the record was created.

◆ ColumnDateCreatedId

readonly short Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.ColumnDateCreatedId = 15
static

used for generic TTypedDataTable functions

◆ ColumnDateEffective

DataColumn Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.ColumnDateEffective

Date the batch comes into effect.

◆ ColumnDateEffectiveId

readonly short Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.ColumnDateEffectiveId = 9
static

used for generic TTypedDataTable functions

◆ ColumnDateModified

DataColumn Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.ColumnDateModified

The date the record was modified.

◆ ColumnDateModifiedId

readonly short Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.ColumnDateModifiedId = 17
static

used for generic TTypedDataTable functions

◆ ColumnDateOfEntry

DataColumn Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.ColumnDateOfEntry

◆ ColumnDateOfEntryId

readonly short Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.ColumnDateOfEntryId = 11
static

used for generic TTypedDataTable functions

◆ ColumnFrequencyCode

DataColumn Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.ColumnFrequencyCode

◆ ColumnFrequencyCodeId

readonly short Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.ColumnFrequencyCodeId = 12
static

used for generic TTypedDataTable functions

◆ ColumnLastJournal

DataColumn Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.ColumnLastJournal

Identifies a journal within a batch.

◆ ColumnLastJournalId

readonly short Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.ColumnLastJournalId = 14
static

used for generic TTypedDataTable functions

◆ ColumnLedgerNumber

DataColumn Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.ColumnLedgerNumber

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

◆ ColumnLedgerNumberId

readonly short Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.ColumnLedgerNumberId = 0
static

used for generic TTypedDataTable functions

◆ ColumnModificationId

DataColumn Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.ColumnModificationId

This identifies the current version of the record.

◆ ColumnModificationIdId

readonly short Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.ColumnModificationIdId = 19
static

used for generic TTypedDataTable functions

◆ ColumnModifiedBy

DataColumn Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.ColumnModifiedBy

User ID of who last modified this record.

◆ ColumnModifiedById

readonly short Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.ColumnModifiedById = 18
static

used for generic TTypedDataTable functions

◆ ColumnUserId

DataColumn Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.ColumnUserId

This identifies who the current user is.

◆ ColumnUserIdId

readonly short Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.ColumnUserIdId = 10
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.Account.Data.ARecurringBatchTable.TableId = 151
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.Account.Data.ARecurringBatchTable.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]

ARecurringBatchRow Ict.Petra.Shared.MFinance.Account.Data.ARecurringBatchTable.this[int i]
get

Access a typed row by index.


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