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

Holds details of each general ledger journal, which contains a group of transactions. More...

Inheritance diagram for Ict.Petra.Shared.MFinance.Account.Data.AJournalTable:
Ict.Common.Data.TTypedDataTable Ict.Petra.Shared.MFinance.GL.Data.GLBatchTDSAJournalTable

Public Member Functions

 AJournalTable ()
 constructor More...
 
 AJournalTable (string ATablename)
 constructor More...
 
 AJournalTable (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...
 
AJournalRow NewRowTyped (bool AWithDefaultValues)
 create a new typed row More...
 
AJournalRow NewRowTyped ()
 create a new typed row, always with default values More...
 
AJournalTable 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 GetJournalNumberDBName ()
 get the name of the field in the database for this column More...
 
static short GetJournalNumberLength ()
 get character length for column More...
 
static string GetJournalNumberHelp ()
 get the help text for the field in the database for this column More...
 
static string GetJournalDescriptionDBName ()
 get the name of the field in the database for this column More...
 
static short GetJournalDescriptionLength ()
 get character length for column More...
 
static string GetJournalDescriptionHelp ()
 get the help text for the field in the database for this column More...
 
static string GetJournalDebitTotalDBName ()
 get the name of the field in the database for this column More...
 
static short GetJournalDebitTotalLength ()
 get character length for column More...
 
static string GetJournalDebitTotalHelp ()
 get the help text for the field in the database for this column More...
 
static string GetJournalCreditTotalDBName ()
 get the name of the field in the database for this column More...
 
static short GetJournalCreditTotalLength ()
 get character length for column More...
 
static string GetJournalCreditTotalHelp ()
 get the help text for the field in the database for this column More...
 
static string GetJournalPeriodDBName ()
 get the name of the field in the database for this column More...
 
static short GetJournalPeriodLength ()
 get character length for column More...
 
static string GetJournalPeriodHelp ()
 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 GetTransactionTypeCodeDBName ()
 get the name of the field in the database for this column More...
 
static short GetTransactionTypeCodeLength ()
 get character length for column More...
 
static string GetTransactionTypeCodeHelp ()
 get the help text for the field in the database for this column More...
 
static string GetLastTransactionNumberDBName ()
 get the name of the field in the database for this column More...
 
static short GetLastTransactionNumberLength ()
 get character length for column More...
 
static string GetLastTransactionNumberHelp ()
 get the help text for the field in the database for this column More...
 
static string GetSubSystemCodeDBName ()
 get the name of the field in the database for this column More...
 
static short GetSubSystemCodeLength ()
 get character length for column More...
 
static string GetSubSystemCodeHelp ()
 get the help text for the field in the database for this column More...
 
static string GetJournalStatusDBName ()
 get the name of the field in the database for this column More...
 
static short GetJournalStatusLength ()
 get character length for column More...
 
static string GetJournalStatusHelp ()
 get the help text for the field in the database for this column More...
 
static string GetTransactionCurrencyDBName ()
 get the name of the field in the database for this column More...
 
static short GetTransactionCurrencyLength ()
 get character length for column More...
 
static string GetTransactionCurrencyHelp ()
 get the help text for the field in the database for this column More...
 
static string GetBaseCurrencyDBName ()
 get the name of the field in the database for this column More...
 
static short GetBaseCurrencyLength ()
 get character length for column More...
 
static string GetBaseCurrencyHelp ()
 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 GetExchangeRateTimeDBName ()
 get the name of the field in the database for this column More...
 
static short GetExchangeRateTimeLength ()
 get character length for column More...
 
static string GetExchangeRateTimeHelp ()
 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 GetReversedDBName ()
 get the name of the field in the database for this column More...
 
static short GetReversedLength ()
 get character length for column More...
 
static string GetReversedHelp ()
 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
 The journal belongs to this ledger. More...
 
DataColumn ColumnBatchNumber
 identifes which batch the journal belongs to. More...
 
DataColumn ColumnJournalNumber
 Identifies a journal within a batch. More...
 
DataColumn ColumnJournalDescription
 This is a long description and is 80 characters long. More...
 
DataColumn ColumnJournalDebitTotal
 This is a number of currency units in the currency of the transaction. More...
 
DataColumn ColumnJournalCreditTotal
 This is the number of currency units in the currency of the transaction. More...
 
DataColumn ColumnJournalPeriod
 This defines which accounting period is being used. More...
 
DataColumn ColumnDateEffective
 Date the journal comes into effect. More...
 
DataColumn ColumnTransactionTypeCode
 Which type of journal is this? Eg. STD, ALLOC, REALLOC, REVAL. More...
 
DataColumn ColumnLastTransactionNumber
 The number of the last transaction within the journal. More...
 
DataColumn ColumnSubSystemCode
 Indicates the sub system of accounts that the journal belongs to. Eg. GL, AP, GR. More...
 
DataColumn ColumnJournalStatus
 Has a journal been posted yet. More...
 
DataColumn ColumnTransactionCurrency
 This defines which currency is being used. More...
 
DataColumn ColumnBaseCurrency
 
DataColumn ColumnExchangeRateToBase
 The rate of exchange from the transaction currency (in a_transaction_currency_c) to the ledger base currency. More...
 
DataColumn ColumnExchangeRateTime
 The time component of the exchange rate. More...
 
DataColumn ColumnDateOfEntry
 Date the journal was created. More...
 
DataColumn ColumnReversed
 Indicates whether or not a journal has been reversed. 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 = 162
 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 ColumnJournalNumberId = 2
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnJournalDescriptionId = 3
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnJournalDebitTotalId = 4
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnJournalCreditTotalId = 5
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnJournalPeriodId = 6
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnDateEffectiveId = 7
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnTransactionTypeCodeId = 8
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnLastTransactionNumberId = 9
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnSubSystemCodeId = 10
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnJournalStatusId = 11
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnTransactionCurrencyId = 12
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnBaseCurrencyId = 13
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnExchangeRateToBaseId = 14
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnExchangeRateTimeId = 15
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnDateOfEntryId = 16
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnReversedId = 17
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnDateCreatedId = 18
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnCreatedById = 19
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnDateModifiedId = 20
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnModifiedById = 21
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnModificationIdId = 22
 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

AJournalRow 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

Holds details of each general ledger journal, which contains a group of transactions.

Constructor & Destructor Documentation

◆ AJournalTable() [1/3]

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

constructor

◆ AJournalTable() [2/3]

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

constructor

◆ AJournalTable() [3/3]

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

get an odbc parameter for the given column

Implements Ict.Common.Data.TTypedDataTable.

Reimplemented in Ict.Petra.Shared.MFinance.GL.Data.GLBatchTDSAJournalTable.

◆ 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

◆ GetBaseCurrencyDBName()

static string Ict.Petra.Shared.MFinance.Account.Data.AJournalTable.GetBaseCurrencyDBName ( )
inlinestatic

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

◆ GetBaseCurrencyHelp()

static string Ict.Petra.Shared.MFinance.Account.Data.AJournalTable.GetBaseCurrencyHelp ( )
inlinestatic

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

◆ GetBaseCurrencyLength()

static short Ict.Petra.Shared.MFinance.Account.Data.AJournalTable.GetBaseCurrencyLength ( )
inlinestatic

get character length for column

◆ GetBatchNumberDBName()

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

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

◆ GetBatchNumberHelp()

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

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

◆ GetBatchNumberLength()

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

AJournalTable Ict.Petra.Shared.MFinance.Account.Data.AJournalTable.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.AJournalTable.GetCreatedByDBName ( )
inlinestatic

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

◆ GetCreatedByHelp()

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

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

◆ GetCreatedByLength()

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

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

◆ GetDateCreatedHelp()

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

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

◆ GetDateCreatedLength()

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

get character length for column

◆ GetDateEffectiveDBName()

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

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

◆ GetDateEffectiveHelp()

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

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

◆ GetDateEffectiveLength()

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

get character length for column

◆ GetDateModifiedDBName()

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

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

◆ GetDateModifiedHelp()

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

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

◆ GetDateModifiedLength()

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

get character length for column

◆ GetDateOfEntryDBName()

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

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

◆ GetDateOfEntryHelp()

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

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

◆ GetDateOfEntryLength()

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

get character length for column

◆ GetExchangeRateTimeDBName()

static string Ict.Petra.Shared.MFinance.Account.Data.AJournalTable.GetExchangeRateTimeDBName ( )
inlinestatic

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

◆ GetExchangeRateTimeHelp()

static string Ict.Petra.Shared.MFinance.Account.Data.AJournalTable.GetExchangeRateTimeHelp ( )
inlinestatic

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

◆ GetExchangeRateTimeLength()

static short Ict.Petra.Shared.MFinance.Account.Data.AJournalTable.GetExchangeRateTimeLength ( )
inlinestatic

get character length for column

◆ GetExchangeRateToBaseDBName()

static string Ict.Petra.Shared.MFinance.Account.Data.AJournalTable.GetExchangeRateToBaseDBName ( )
inlinestatic

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

◆ GetExchangeRateToBaseHelp()

static string Ict.Petra.Shared.MFinance.Account.Data.AJournalTable.GetExchangeRateToBaseHelp ( )
inlinestatic

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

◆ GetExchangeRateToBaseLength()

static short Ict.Petra.Shared.MFinance.Account.Data.AJournalTable.GetExchangeRateToBaseLength ( )
inlinestatic

get character length for column

◆ GetJournalCreditTotalDBName()

static string Ict.Petra.Shared.MFinance.Account.Data.AJournalTable.GetJournalCreditTotalDBName ( )
inlinestatic

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

◆ GetJournalCreditTotalHelp()

static string Ict.Petra.Shared.MFinance.Account.Data.AJournalTable.GetJournalCreditTotalHelp ( )
inlinestatic

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

◆ GetJournalCreditTotalLength()

static short Ict.Petra.Shared.MFinance.Account.Data.AJournalTable.GetJournalCreditTotalLength ( )
inlinestatic

get character length for column

◆ GetJournalDebitTotalDBName()

static string Ict.Petra.Shared.MFinance.Account.Data.AJournalTable.GetJournalDebitTotalDBName ( )
inlinestatic

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

◆ GetJournalDebitTotalHelp()

static string Ict.Petra.Shared.MFinance.Account.Data.AJournalTable.GetJournalDebitTotalHelp ( )
inlinestatic

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

◆ GetJournalDebitTotalLength()

static short Ict.Petra.Shared.MFinance.Account.Data.AJournalTable.GetJournalDebitTotalLength ( )
inlinestatic

get character length for column

◆ GetJournalDescriptionDBName()

static string Ict.Petra.Shared.MFinance.Account.Data.AJournalTable.GetJournalDescriptionDBName ( )
inlinestatic

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

◆ GetJournalDescriptionHelp()

static string Ict.Petra.Shared.MFinance.Account.Data.AJournalTable.GetJournalDescriptionHelp ( )
inlinestatic

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

◆ GetJournalDescriptionLength()

static short Ict.Petra.Shared.MFinance.Account.Data.AJournalTable.GetJournalDescriptionLength ( )
inlinestatic

get character length for column

◆ GetJournalNumberDBName()

static string Ict.Petra.Shared.MFinance.Account.Data.AJournalTable.GetJournalNumberDBName ( )
inlinestatic

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

◆ GetJournalNumberHelp()

static string Ict.Petra.Shared.MFinance.Account.Data.AJournalTable.GetJournalNumberHelp ( )
inlinestatic

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

◆ GetJournalNumberLength()

static short Ict.Petra.Shared.MFinance.Account.Data.AJournalTable.GetJournalNumberLength ( )
inlinestatic

get character length for column

◆ GetJournalPeriodDBName()

static string Ict.Petra.Shared.MFinance.Account.Data.AJournalTable.GetJournalPeriodDBName ( )
inlinestatic

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

◆ GetJournalPeriodHelp()

static string Ict.Petra.Shared.MFinance.Account.Data.AJournalTable.GetJournalPeriodHelp ( )
inlinestatic

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

◆ GetJournalPeriodLength()

static short Ict.Petra.Shared.MFinance.Account.Data.AJournalTable.GetJournalPeriodLength ( )
inlinestatic

get character length for column

◆ GetJournalStatusDBName()

static string Ict.Petra.Shared.MFinance.Account.Data.AJournalTable.GetJournalStatusDBName ( )
inlinestatic

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

◆ GetJournalStatusHelp()

static string Ict.Petra.Shared.MFinance.Account.Data.AJournalTable.GetJournalStatusHelp ( )
inlinestatic

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

◆ GetJournalStatusLength()

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

◆ GetLastTransactionNumberDBName()

static string Ict.Petra.Shared.MFinance.Account.Data.AJournalTable.GetLastTransactionNumberDBName ( )
inlinestatic

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

◆ GetLastTransactionNumberHelp()

static string Ict.Petra.Shared.MFinance.Account.Data.AJournalTable.GetLastTransactionNumberHelp ( )
inlinestatic

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

◆ GetLastTransactionNumberLength()

static short Ict.Petra.Shared.MFinance.Account.Data.AJournalTable.GetLastTransactionNumberLength ( )
inlinestatic

get character length for column

◆ GetLedgerNumberDBName()

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

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

◆ GetLedgerNumberHelp()

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

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

◆ GetLedgerNumberLength()

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

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

◆ GetModificationIdHelp()

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

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

◆ GetModificationIdLength()

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

get character length for column

◆ GetModifiedByDBName()

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

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

◆ GetModifiedByHelp()

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

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

◆ GetModifiedByLength()

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

◆ GetReversedDBName()

static string Ict.Petra.Shared.MFinance.Account.Data.AJournalTable.GetReversedDBName ( )
inlinestatic

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

◆ GetReversedHelp()

static string Ict.Petra.Shared.MFinance.Account.Data.AJournalTable.GetReversedHelp ( )
inlinestatic

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

◆ GetReversedLength()

static short Ict.Petra.Shared.MFinance.Account.Data.AJournalTable.GetReversedLength ( )
inlinestatic

get character length for column

◆ GetSubSystemCodeDBName()

static string Ict.Petra.Shared.MFinance.Account.Data.AJournalTable.GetSubSystemCodeDBName ( )
inlinestatic

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

◆ GetSubSystemCodeHelp()

static string Ict.Petra.Shared.MFinance.Account.Data.AJournalTable.GetSubSystemCodeHelp ( )
inlinestatic

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

◆ GetSubSystemCodeLength()

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

◆ GetTransactionCurrencyDBName()

static string Ict.Petra.Shared.MFinance.Account.Data.AJournalTable.GetTransactionCurrencyDBName ( )
inlinestatic

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

◆ GetTransactionCurrencyHelp()

static string Ict.Petra.Shared.MFinance.Account.Data.AJournalTable.GetTransactionCurrencyHelp ( )
inlinestatic

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

◆ GetTransactionCurrencyLength()

static short Ict.Petra.Shared.MFinance.Account.Data.AJournalTable.GetTransactionCurrencyLength ( )
inlinestatic

get character length for column

◆ GetTransactionTypeCodeDBName()

static string Ict.Petra.Shared.MFinance.Account.Data.AJournalTable.GetTransactionTypeCodeDBName ( )
inlinestatic

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

◆ GetTransactionTypeCodeHelp()

static string Ict.Petra.Shared.MFinance.Account.Data.AJournalTable.GetTransactionTypeCodeHelp ( )
inlinestatic

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

◆ GetTransactionTypeCodeLength()

static short Ict.Petra.Shared.MFinance.Account.Data.AJournalTable.GetTransactionTypeCodeLength ( )
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.Account.Data.AJournalTable.InitClass ( )
inlineprotectedvirtual

◆ InitVars()

override void Ict.Petra.Shared.MFinance.Account.Data.AJournalTable.InitVars ( )
inlinevirtual

assign columns to properties, set primary key

Implements Ict.Common.Data.TTypedDataTable.

Reimplemented in Ict.Petra.Shared.MFinance.GL.Data.GLBatchTDSAJournalTable.

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

new typed row using DataRowBuilder

◆ NewRowTyped() [1/2]

AJournalRow Ict.Petra.Shared.MFinance.Account.Data.AJournalTable.NewRowTyped ( )
inline

create a new typed row, always with default values

◆ NewRowTyped() [2/2]

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

◆ ColumnBaseCurrency

DataColumn Ict.Petra.Shared.MFinance.Account.Data.AJournalTable.ColumnBaseCurrency

◆ ColumnBaseCurrencyId

readonly short Ict.Petra.Shared.MFinance.Account.Data.AJournalTable.ColumnBaseCurrencyId = 13
static

used for generic TTypedDataTable functions

◆ ColumnBatchNumber

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

identifes which batch the journal belongs to.

◆ ColumnBatchNumberId

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

used for generic TTypedDataTable functions

◆ ColumnCreatedBy

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

User ID of who created this record.

◆ ColumnCreatedById

readonly short Ict.Petra.Shared.MFinance.Account.Data.AJournalTable.ColumnCreatedById = 19
static

used for generic TTypedDataTable functions

◆ ColumnDateCreated

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

The date the record was created.

◆ ColumnDateCreatedId

readonly short Ict.Petra.Shared.MFinance.Account.Data.AJournalTable.ColumnDateCreatedId = 18
static

used for generic TTypedDataTable functions

◆ ColumnDateEffective

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

Date the journal comes into effect.

◆ ColumnDateEffectiveId

readonly short Ict.Petra.Shared.MFinance.Account.Data.AJournalTable.ColumnDateEffectiveId = 7
static

used for generic TTypedDataTable functions

◆ ColumnDateModified

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

The date the record was modified.

◆ ColumnDateModifiedId

readonly short Ict.Petra.Shared.MFinance.Account.Data.AJournalTable.ColumnDateModifiedId = 20
static

used for generic TTypedDataTable functions

◆ ColumnDateOfEntry

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

Date the journal was created.

◆ ColumnDateOfEntryId

readonly short Ict.Petra.Shared.MFinance.Account.Data.AJournalTable.ColumnDateOfEntryId = 16
static

used for generic TTypedDataTable functions

◆ ColumnExchangeRateTime

DataColumn Ict.Petra.Shared.MFinance.Account.Data.AJournalTable.ColumnExchangeRateTime

The time component of the exchange rate.

◆ ColumnExchangeRateTimeId

readonly short Ict.Petra.Shared.MFinance.Account.Data.AJournalTable.ColumnExchangeRateTimeId = 15
static

used for generic TTypedDataTable functions

◆ ColumnExchangeRateToBase

DataColumn Ict.Petra.Shared.MFinance.Account.Data.AJournalTable.ColumnExchangeRateToBase

The rate of exchange from the transaction currency (in a_transaction_currency_c) to the ledger base currency.

◆ ColumnExchangeRateToBaseId

readonly short Ict.Petra.Shared.MFinance.Account.Data.AJournalTable.ColumnExchangeRateToBaseId = 14
static

used for generic TTypedDataTable functions

◆ ColumnJournalCreditTotal

DataColumn Ict.Petra.Shared.MFinance.Account.Data.AJournalTable.ColumnJournalCreditTotal

This is the number of currency units in the currency of the transaction.

◆ ColumnJournalCreditTotalId

readonly short Ict.Petra.Shared.MFinance.Account.Data.AJournalTable.ColumnJournalCreditTotalId = 5
static

used for generic TTypedDataTable functions

◆ ColumnJournalDebitTotal

DataColumn Ict.Petra.Shared.MFinance.Account.Data.AJournalTable.ColumnJournalDebitTotal

This is a number of currency units in the currency of the transaction.

◆ ColumnJournalDebitTotalId

readonly short Ict.Petra.Shared.MFinance.Account.Data.AJournalTable.ColumnJournalDebitTotalId = 4
static

used for generic TTypedDataTable functions

◆ ColumnJournalDescription

DataColumn Ict.Petra.Shared.MFinance.Account.Data.AJournalTable.ColumnJournalDescription

This is a long description and is 80 characters long.

◆ ColumnJournalDescriptionId

readonly short Ict.Petra.Shared.MFinance.Account.Data.AJournalTable.ColumnJournalDescriptionId = 3
static

used for generic TTypedDataTable functions

◆ ColumnJournalNumber

DataColumn Ict.Petra.Shared.MFinance.Account.Data.AJournalTable.ColumnJournalNumber

Identifies a journal within a batch.

◆ ColumnJournalNumberId

readonly short Ict.Petra.Shared.MFinance.Account.Data.AJournalTable.ColumnJournalNumberId = 2
static

used for generic TTypedDataTable functions

◆ ColumnJournalPeriod

DataColumn Ict.Petra.Shared.MFinance.Account.Data.AJournalTable.ColumnJournalPeriod

This defines which accounting period is being used.

◆ ColumnJournalPeriodId

readonly short Ict.Petra.Shared.MFinance.Account.Data.AJournalTable.ColumnJournalPeriodId = 6
static

used for generic TTypedDataTable functions

◆ ColumnJournalStatus

DataColumn Ict.Petra.Shared.MFinance.Account.Data.AJournalTable.ColumnJournalStatus

Has a journal been posted yet.

◆ ColumnJournalStatusId

readonly short Ict.Petra.Shared.MFinance.Account.Data.AJournalTable.ColumnJournalStatusId = 11
static

used for generic TTypedDataTable functions

◆ ColumnLastTransactionNumber

DataColumn Ict.Petra.Shared.MFinance.Account.Data.AJournalTable.ColumnLastTransactionNumber

The number of the last transaction within the journal.

◆ ColumnLastTransactionNumberId

readonly short Ict.Petra.Shared.MFinance.Account.Data.AJournalTable.ColumnLastTransactionNumberId = 9
static

used for generic TTypedDataTable functions

◆ ColumnLedgerNumber

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

The journal belongs to this ledger.

◆ ColumnLedgerNumberId

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

used for generic TTypedDataTable functions

◆ ColumnModificationId

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

This identifies the current version of the record.

◆ ColumnModificationIdId

readonly short Ict.Petra.Shared.MFinance.Account.Data.AJournalTable.ColumnModificationIdId = 22
static

used for generic TTypedDataTable functions

◆ ColumnModifiedBy

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

User ID of who last modified this record.

◆ ColumnModifiedById

readonly short Ict.Petra.Shared.MFinance.Account.Data.AJournalTable.ColumnModifiedById = 21
static

used for generic TTypedDataTable functions

◆ ColumnReversed

DataColumn Ict.Petra.Shared.MFinance.Account.Data.AJournalTable.ColumnReversed

Indicates whether or not a journal has been reversed.

◆ ColumnReversedId

readonly short Ict.Petra.Shared.MFinance.Account.Data.AJournalTable.ColumnReversedId = 17
static

used for generic TTypedDataTable functions

◆ ColumnSubSystemCode

DataColumn Ict.Petra.Shared.MFinance.Account.Data.AJournalTable.ColumnSubSystemCode

Indicates the sub system of accounts that the journal belongs to. Eg. GL, AP, GR.

◆ ColumnSubSystemCodeId

readonly short Ict.Petra.Shared.MFinance.Account.Data.AJournalTable.ColumnSubSystemCodeId = 10
static

used for generic TTypedDataTable functions

◆ ColumnTransactionCurrency

DataColumn Ict.Petra.Shared.MFinance.Account.Data.AJournalTable.ColumnTransactionCurrency

This defines which currency is being used.

◆ ColumnTransactionCurrencyId

readonly short Ict.Petra.Shared.MFinance.Account.Data.AJournalTable.ColumnTransactionCurrencyId = 12
static

used for generic TTypedDataTable functions

◆ ColumnTransactionTypeCode

DataColumn Ict.Petra.Shared.MFinance.Account.Data.AJournalTable.ColumnTransactionTypeCode

Which type of journal is this? Eg. STD, ALLOC, REALLOC, REVAL.

◆ ColumnTransactionTypeCodeId

readonly short Ict.Petra.Shared.MFinance.Account.Data.AJournalTable.ColumnTransactionTypeCodeId = 8
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.AJournalTable.TableId = 162
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.AJournalTable.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]

AJournalRow Ict.Petra.Shared.MFinance.Account.Data.AJournalTable.this[int i]
get

Access a typed row by index.


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