Store current and forward period general ledger batches for a ledger. More...

Inheritance diagram for Ict.Petra.Shared.MFinance.Account.Data.ABatchTable:

Public Member Functions
	ABatchTable ()
	constructor More...

	ABatchTable (string ATablename)
	constructor More...

	ABatchTable (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...

ABatchRow	NewRowTyped (bool AWithDefaultValues)
	create a new typed row More...

ABatchRow	NewRowTyped ()
	create a new typed row, always with default values More...

ABatchTable	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	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	GetBatchYearDBName ()
	get the name of the field in the database for this column More...

static short	GetBatchYearLength ()
	get character length for column More...

static string	GetBatchYearHelp ()
	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	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	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	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	GetGiftBatchNumberDBName ()
	get the name of the field in the database for this column More...

static short	GetGiftBatchNumberLength ()
	get character length for column More...

static string	GetGiftBatchNumberHelp ()
	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 ledger that the batch belongs to. More...

DataColumn	ColumnBatchNumber
	Identifies the batch. More...

DataColumn	ColumnBatchDescription
	This is a long description and is 80 characters long. More...

DataColumn	ColumnBatchControlTotal
	Raw total amount of the batch. If the journals within the batch have different currencies, this is just a raw numeric sum of all the journal amounts. It does not reflect a monetary value in a specific currency. Entered by the user. More...

DataColumn	ColumnBatchRunningTotal
	Running total amount of the batch calculated as transactions are enterd. If the journals within the batch have different currencies, this is just a raw numeric sum of all the journal amounts. It does not reflect a monetary value in a specific currency. More...

DataColumn	ColumnBatchDebitTotal
	Raw debit total amount of the batch. If the journals within the batch have different currencies, this is just a raw numeric sum of all the journal amounts. It does not reflect a monetary value in a specific currency. More...

DataColumn	ColumnBatchCreditTotal
	Raw credit total amount of the batch. If the journals within the batch have different currencies, this is just a raw numeric sum of all the journal amounts. It does not reflect a monetary value in a specific currency. More...

DataColumn	ColumnBatchPeriod
	This identifies which accounting period that the batch belongs to. More...

DataColumn	ColumnBatchYear
	The number of the accounting year. More...

DataColumn	ColumnDateEffective
	Date the batch comes into effect. More...

DataColumn	ColumnDateOfEntry
	Date the batch was created. More...

DataColumn	ColumnBatchStatus
	Has this batch been posted yet? More...

DataColumn	ColumnLastJournal
	Identifies a journal within a batch. More...

DataColumn	ColumnGiftBatchNumber
	Number of the originating gift batch that generated this GL 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 = 161
	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	ColumnBatchRunningTotalId = 4
	used for generic TTypedDataTable functions More...

static readonly short	ColumnBatchDebitTotalId = 5
	used for generic TTypedDataTable functions More...

static readonly short	ColumnBatchCreditTotalId = 6
	used for generic TTypedDataTable functions More...

static readonly short	ColumnBatchPeriodId = 7
	used for generic TTypedDataTable functions More...

static readonly short	ColumnBatchYearId = 8
	used for generic TTypedDataTable functions More...

static readonly short	ColumnDateEffectiveId = 9
	used for generic TTypedDataTable functions More...

static readonly short	ColumnDateOfEntryId = 10
	used for generic TTypedDataTable functions More...

static readonly short	ColumnBatchStatusId = 11
	used for generic TTypedDataTable functions More...

static readonly short	ColumnLastJournalId = 12
	used for generic TTypedDataTable functions More...

static readonly short	ColumnGiftBatchNumberId = 13
	used for generic TTypedDataTable functions More...

static readonly short	ColumnDateCreatedId = 14
	used for generic TTypedDataTable functions More...

static readonly short	ColumnCreatedById = 15
	used for generic TTypedDataTable functions More...

static readonly short	ColumnDateModifiedId = 16
	used for generic TTypedDataTable functions More...

static readonly short	ColumnModifiedById = 17
	used for generic TTypedDataTable functions More...

static readonly short	ColumnModificationIdId = 18
	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, TTypedTableInfo >	TableInfo = new SortedList <short, TTypedTableInfo>()
	stores information about typed tables More...

Properties
ABatchRow	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

Store current and forward period general ledger batches for a ledger.

Constructor & Destructor Documentation

◆ ABatchTable() [1/3]

Ict.Petra.Shared.MFinance.Account.Data.ABatchTable.ABatchTable ( )

inline

constructor

◆ ABatchTable() [2/3]

Ict.Petra.Shared.MFinance.Account.Data.ABatchTable.ABatchTable ( string ATablename )

inline

constructor

◆ ABatchTable() [3/3]

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

◆ 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.ABatchTable.GetBatchControlTotalDBName ( )

inlinestatic

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

◆ GetBatchControlTotalHelp()

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

inlinestatic

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

◆ GetBatchControlTotalLength()

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

inlinestatic

get character length for column

◆ GetBatchCreditTotalDBName()

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

inlinestatic

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

◆ GetBatchCreditTotalHelp()

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

inlinestatic

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

◆ GetBatchCreditTotalLength()

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

inlinestatic

get character length for column

◆ GetBatchDebitTotalDBName()

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

inlinestatic

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

◆ GetBatchDebitTotalHelp()

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

inlinestatic

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

◆ GetBatchDebitTotalLength()

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

inlinestatic

get character length for column

◆ GetBatchDescriptionDBName()

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

inlinestatic

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

◆ GetBatchDescriptionHelp()

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

inlinestatic

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

◆ GetBatchDescriptionLength()

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

inlinestatic

get character length for column

◆ GetBatchNumberDBName()

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

inlinestatic

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

◆ GetBatchNumberHelp()

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

inlinestatic

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

◆ GetBatchNumberLength()

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

inlinestatic

get character length for column

◆ GetBatchPeriodDBName()

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

inlinestatic

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

◆ GetBatchPeriodHelp()

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

inlinestatic

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

◆ GetBatchPeriodLength()

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

inlinestatic

get character length for column

◆ GetBatchRunningTotalDBName()

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

inlinestatic

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

◆ GetBatchRunningTotalHelp()

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

inlinestatic

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

◆ GetBatchRunningTotalLength()

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

inlinestatic

get character length for column

◆ GetBatchStatusDBName()

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

inlinestatic

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

◆ GetBatchStatusHelp()

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

inlinestatic

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

◆ GetBatchStatusLength()

static short Ict.Petra.Shared.MFinance.Account.Data.ABatchTable.GetBatchStatusLength ( )

inlinestatic

get character length for column

◆ GetBatchYearDBName()

static string Ict.Petra.Shared.MFinance.Account.Data.ABatchTable.GetBatchYearDBName ( )

inlinestatic

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

◆ GetBatchYearHelp()

static string Ict.Petra.Shared.MFinance.Account.Data.ABatchTable.GetBatchYearHelp ( )

inlinestatic

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

◆ GetBatchYearLength()

static short Ict.Petra.Shared.MFinance.Account.Data.ABatchTable.GetBatchYearLength ( )

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

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

inlinestatic

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

◆ GetCreatedByHelp()

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

inlinestatic

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

◆ GetCreatedByLength()

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

inlinestatic

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

◆ GetDateCreatedHelp()

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

inlinestatic

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

◆ GetDateCreatedLength()

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

inlinestatic

get character length for column

◆ GetDateEffectiveDBName()

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

inlinestatic

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

◆ GetDateEffectiveHelp()

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

inlinestatic

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

◆ GetDateEffectiveLength()

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

inlinestatic

get character length for column

◆ GetDateModifiedDBName()

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

inlinestatic

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

◆ GetDateModifiedHelp()

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

inlinestatic

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

◆ GetDateModifiedLength()

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

inlinestatic

get character length for column

◆ GetDateOfEntryDBName()

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

inlinestatic

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

◆ GetDateOfEntryHelp()

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

inlinestatic

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

◆ GetDateOfEntryLength()

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

inlinestatic

get character length for column

◆ GetGiftBatchNumberDBName()

static string Ict.Petra.Shared.MFinance.Account.Data.ABatchTable.GetGiftBatchNumberDBName ( )

inlinestatic

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

◆ GetGiftBatchNumberHelp()

static string Ict.Petra.Shared.MFinance.Account.Data.ABatchTable.GetGiftBatchNumberHelp ( )

inlinestatic

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

◆ GetGiftBatchNumberLength()

static short Ict.Petra.Shared.MFinance.Account.Data.ABatchTable.GetGiftBatchNumberLength ( )

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.ABatchTable.GetLastJournalDBName ( )

inlinestatic

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

◆ GetLastJournalHelp()

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

inlinestatic

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

◆ GetLastJournalLength()

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

inlinestatic

get character length for column

◆ GetLedgerNumberDBName()

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

inlinestatic

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

◆ GetLedgerNumberHelp()

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

inlinestatic

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

◆ GetLedgerNumberLength()

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

inlinestatic

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

◆ GetModificationIdHelp()

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

inlinestatic

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

◆ GetModificationIdLength()

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

inlinestatic

get character length for column

◆ GetModifiedByDBName()

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

inlinestatic

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

◆ GetModifiedByHelp()

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

inlinestatic

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

◆ GetModifiedByLength()

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

◆ InitClass()

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

inlineprotectedvirtual

create the columns

Implements Ict.Common.Data.TTypedDataTable.

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

◆ InitVars()

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

inlinevirtual

assign columns to properties, set primary key

Implements Ict.Common.Data.TTypedDataTable.

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

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

inlineprotected

new typed row using DataRowBuilder

◆ NewRowTyped() [1/2]

ABatchRow Ict.Petra.Shared.MFinance.Account.Data.ABatchTable.NewRowTyped ( )

inline

create a new typed row, always with default values

◆ NewRowTyped() [2/2]

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

ATableTemplate this 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.ABatchTable.ColumnBatchControlTotal

Raw total amount of the batch. If the journals within the batch have different currencies, this is just a raw numeric sum of all the journal amounts. It does not reflect a monetary value in a specific currency. Entered by the user.

◆ ColumnBatchControlTotalId

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

static

used for generic TTypedDataTable functions

◆ ColumnBatchCreditTotal

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

Raw credit total amount of the batch. If the journals within the batch have different currencies, this is just a raw numeric sum of all the journal amounts. It does not reflect a monetary value in a specific currency.

◆ ColumnBatchCreditTotalId

readonly short Ict.Petra.Shared.MFinance.Account.Data.ABatchTable.ColumnBatchCreditTotalId = 6

static

used for generic TTypedDataTable functions

◆ ColumnBatchDebitTotal

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

Raw debit total amount of the batch. If the journals within the batch have different currencies, this is just a raw numeric sum of all the journal amounts. It does not reflect a monetary value in a specific currency.

◆ ColumnBatchDebitTotalId

readonly short Ict.Petra.Shared.MFinance.Account.Data.ABatchTable.ColumnBatchDebitTotalId = 5

static

used for generic TTypedDataTable functions

◆ ColumnBatchDescription

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

This is a long description and is 80 characters long.

◆ ColumnBatchDescriptionId

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

static

used for generic TTypedDataTable functions

◆ ColumnBatchNumber

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

Identifies the batch.

◆ ColumnBatchNumberId

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

static

used for generic TTypedDataTable functions

◆ ColumnBatchPeriod

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

This identifies which accounting period that the batch belongs to.

◆ ColumnBatchPeriodId

readonly short Ict.Petra.Shared.MFinance.Account.Data.ABatchTable.ColumnBatchPeriodId = 7

static

used for generic TTypedDataTable functions

◆ ColumnBatchRunningTotal

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

Running total amount of the batch calculated as transactions are enterd. If the journals within the batch have different currencies, this is just a raw numeric sum of all the journal amounts. It does not reflect a monetary value in a specific currency.

◆ ColumnBatchRunningTotalId

readonly short Ict.Petra.Shared.MFinance.Account.Data.ABatchTable.ColumnBatchRunningTotalId = 4

static

used for generic TTypedDataTable functions

◆ ColumnBatchStatus

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

Has this batch been posted yet?

◆ ColumnBatchStatusId

readonly short Ict.Petra.Shared.MFinance.Account.Data.ABatchTable.ColumnBatchStatusId = 11

static

used for generic TTypedDataTable functions

◆ ColumnBatchYear

DataColumn Ict.Petra.Shared.MFinance.Account.Data.ABatchTable.ColumnBatchYear

The number of the accounting year.

◆ ColumnBatchYearId

readonly short Ict.Petra.Shared.MFinance.Account.Data.ABatchTable.ColumnBatchYearId = 8

static

used for generic TTypedDataTable functions

◆ ColumnCreatedBy

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

User ID of who created this record.

◆ ColumnCreatedById

readonly short Ict.Petra.Shared.MFinance.Account.Data.ABatchTable.ColumnCreatedById = 15

static

used for generic TTypedDataTable functions

◆ ColumnDateCreated

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

The date the record was created.

◆ ColumnDateCreatedId

readonly short Ict.Petra.Shared.MFinance.Account.Data.ABatchTable.ColumnDateCreatedId = 14

static

used for generic TTypedDataTable functions

◆ ColumnDateEffective

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

Date the batch comes into effect.

◆ ColumnDateEffectiveId

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

static

used for generic TTypedDataTable functions

◆ ColumnDateModified

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

The date the record was modified.

◆ ColumnDateModifiedId

readonly short Ict.Petra.Shared.MFinance.Account.Data.ABatchTable.ColumnDateModifiedId = 16

static

used for generic TTypedDataTable functions

◆ ColumnDateOfEntry

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

Date the batch was created.

◆ ColumnDateOfEntryId

readonly short Ict.Petra.Shared.MFinance.Account.Data.ABatchTable.ColumnDateOfEntryId = 10

static

used for generic TTypedDataTable functions

◆ ColumnGiftBatchNumber

DataColumn Ict.Petra.Shared.MFinance.Account.Data.ABatchTable.ColumnGiftBatchNumber

Number of the originating gift batch that generated this GL batch.

◆ ColumnGiftBatchNumberId

readonly short Ict.Petra.Shared.MFinance.Account.Data.ABatchTable.ColumnGiftBatchNumberId = 13

static

used for generic TTypedDataTable functions

◆ ColumnLastJournal

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

Identifies a journal within a batch.

◆ ColumnLastJournalId

readonly short Ict.Petra.Shared.MFinance.Account.Data.ABatchTable.ColumnLastJournalId = 12

static

used for generic TTypedDataTable functions

◆ ColumnLedgerNumber

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

The ledger that the batch belongs to.

◆ ColumnLedgerNumberId

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

static

used for generic TTypedDataTable functions

◆ ColumnModificationId

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

This identifies the current version of the record.

◆ ColumnModificationIdId

readonly short Ict.Petra.Shared.MFinance.Account.Data.ABatchTable.ColumnModificationIdId = 18

static

used for generic TTypedDataTable functions

◆ ColumnModifiedBy

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

User ID of who last modified this record.

◆ ColumnModifiedById

readonly short Ict.Petra.Shared.MFinance.Account.Data.ABatchTable.ColumnModifiedById = 17

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.ABatchTable.TableId = 161

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.ABatchTable.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]

ABatchRow Ict.Petra.Shared.MFinance.Account.Data.ABatchTable.this[int i]

get

Access a typed row by index.

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

csharp/ICT/Petra/Shared/lib/data/Account.Tables-generated.cs

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Static Protected Attributes

Properties

Detailed Description

Constructor & Destructor Documentation

◆ ABatchTable() [1/3]

◆ ABatchTable() [2/3]

◆ ABatchTable() [3/3]

Member Function Documentation

◆ CreateOdbcParameter() [1/3]

◆ CreateOdbcParameter() [2/3]

◆ CreateOdbcParameter() [3/3]

◆ GetBatchControlTotalDBName()

◆ GetBatchControlTotalHelp()

◆ GetBatchControlTotalLength()

◆ GetBatchCreditTotalDBName()

◆ GetBatchCreditTotalHelp()

◆ GetBatchCreditTotalLength()

◆ GetBatchDebitTotalDBName()

◆ GetBatchDebitTotalHelp()

◆ GetBatchDebitTotalLength()

◆ GetBatchDescriptionDBName()

◆ GetBatchDescriptionHelp()

◆ GetBatchDescriptionLength()

◆ GetBatchNumberDBName()

◆ GetBatchNumberHelp()

◆ GetBatchNumberLength()

◆ GetBatchPeriodDBName()

◆ GetBatchPeriodHelp()

◆ GetBatchPeriodLength()

◆ GetBatchRunningTotalDBName()

◆ GetBatchRunningTotalHelp()

◆ GetBatchRunningTotalLength()

◆ GetBatchStatusDBName()

◆ GetBatchStatusHelp()

◆ GetBatchStatusLength()

◆ GetBatchYearDBName()

◆ GetBatchYearHelp()

◆ GetBatchYearLength()

◆ GetChanges()

◆ GetChangesTyped()

◆ GetChangesTypedInternal()

◆ GetColumnNameSQL()

◆ GetColumnStringList()

◆ GetCreatedByDBName()

◆ GetCreatedByHelp()

◆ GetCreatedByLength()

◆ GetCustomReportFieldList()

◆ GetCustomReportPermission()

◆ GetDateCreatedDBName()

◆ GetDateCreatedHelp()

◆ GetDateCreatedLength()

◆ GetDateEffectiveDBName()

◆ GetDateEffectiveHelp()

◆ GetDateEffectiveLength()

◆ GetDateModifiedDBName()

◆ GetDateModifiedHelp()

◆ GetDateModifiedLength()

◆ GetDateOfEntryDBName()

◆ GetDateOfEntryHelp()

◆ GetDateOfEntryLength()

◆ GetGiftBatchNumberDBName()

◆ GetGiftBatchNumberHelp()

◆ GetGiftBatchNumberLength()

◆ GetKeyColumnStringList()

◆ GetLabel()

◆ GetLastJournalDBName()

◆ GetLastJournalHelp()

◆ GetLastJournalLength()

◆ GetLedgerNumberDBName()

◆ GetLedgerNumberHelp()

◆ GetLedgerNumberLength()

◆ GetLength() [1/2]

◆ GetLength() [2/2]

◆ GetModificationIdDBName()

◆ GetModificationIdHelp()