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

an invoice consists of one or more details More...

Inheritance diagram for Ict.Petra.Shared.MFinance.AR.Data.AArInvoiceDetailTable:
Ict.Common.Data.TTypedDataTable

Public Member Functions

 AArInvoiceDetailTable ()
 constructor More...
 
 AArInvoiceDetailTable (string ATablename)
 constructor More...
 
 AArInvoiceDetailTable (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...
 
AArInvoiceDetailRow NewRowTyped (bool AWithDefaultValues)
 create a new typed row More...
 
AArInvoiceDetailRow NewRowTyped ()
 create a new typed row, always with default values More...
 
AArInvoiceDetailTable 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 GetInvoiceKeyDBName ()
 get the name of the field in the database for this column More...
 
static short GetInvoiceKeyLength ()
 get character length for column More...
 
static string GetInvoiceKeyHelp ()
 get the help text for the field in the database for this column More...
 
static string GetDetailNumberDBName ()
 get the name of the field in the database for this column More...
 
static short GetDetailNumberLength ()
 get character length for column More...
 
static string GetDetailNumberHelp ()
 get the help text for the field in the database for this column More...
 
static string GetArArticleCodeDBName ()
 get the name of the field in the database for this column More...
 
static short GetArArticleCodeLength ()
 get character length for column More...
 
static string GetArArticleCodeHelp ()
 get the help text for the field in the database for this column More...
 
static string GetArReferenceDBName ()
 get the name of the field in the database for this column More...
 
static short GetArReferenceLength ()
 get character length for column More...
 
static string GetArReferenceHelp ()
 get the help text for the field in the database for this column More...
 
static string GetArNumberOfItemDBName ()
 get the name of the field in the database for this column More...
 
static short GetArNumberOfItemLength ()
 get character length for column More...
 
static string GetArNumberOfItemHelp ()
 get the help text for the field in the database for this column More...
 
static string GetArArticlePriceDBName ()
 get the name of the field in the database for this column More...
 
static short GetArArticlePriceLength ()
 get character length for column More...
 
static string GetArArticlePriceHelp ()
 get the help text for the field in the database for this column More...
 
static string GetCalculatedAmountDBName ()
 get the name of the field in the database for this column More...
 
static short GetCalculatedAmountLength ()
 get character length for column More...
 
static string GetCalculatedAmountHelp ()
 get the help text for the field in the database for this column More...
 
static string GetCurrencyCodeDBName ()
 get the name of the field in the database for this column More...
 
static short GetCurrencyCodeLength ()
 get character length for column More...
 
static string GetCurrencyCodeHelp ()
 get the help text for the field in the database for this column More...
 
static string GetTaxTypeCodeDBName ()
 get the name of the field in the database for this column More...
 
static short GetTaxTypeCodeLength ()
 get character length for column More...
 
static string GetTaxTypeCodeHelp ()
 get the help text for the field in the database for this column More...
 
static string GetTaxRateCodeDBName ()
 get the name of the field in the database for this column More...
 
static short GetTaxRateCodeLength ()
 get character length for column More...
 
static string GetTaxRateCodeHelp ()
 get the help text for the field in the database for this column More...
 
static string GetTaxValidFromDBName ()
 get the name of the field in the database for this column More...
 
static short GetTaxValidFromLength ()
 get character length for column More...
 
static string GetTaxValidFromHelp ()
 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 ColumnInvoiceKey
 this invoice detail belongs to the invoice with this key More...
 
DataColumn ColumnDetailNumber
 A unique number for this detail for its invoice. More...
 
DataColumn ColumnArArticleCode
 code that uniquely identifies the item; can also be a code of a group of equally priced items More...
 
DataColumn ColumnArReference
 Reference for this invoice detail; for a non specific article that could give more details (e.g. which book of type small book) More...
 
DataColumn ColumnArNumberOfItem
 defines the number of the article items that is bought More...
 
DataColumn ColumnArArticlePrice
 Reference to the price that should be used for this article in this invoice, by date; without discounts, just for single item. More...
 
DataColumn ColumnCalculatedAmount
 The total amount of money that this invoice detail is worth; includes the discounts. More...
 
DataColumn ColumnCurrencyCode
 the currency of the total amount More...
 
DataColumn ColumnTaxTypeCode
 The tax type is always the same, e.g. VAT. More...
 
DataColumn ColumnTaxRateCode
 this describes whether it is e.g. the standard, reduced or zero rate of VAT More...
 
DataColumn ColumnTaxValidFrom
 we need to be able to pick a rate that was valid in the past or will be valid in the future 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 = 186
 TableId for Ict.Common.Data generic functions. More...
 
static readonly short ColumnLedgerNumberId = 0
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnInvoiceKeyId = 1
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnDetailNumberId = 2
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnArArticleCodeId = 3
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnArReferenceId = 4
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnArNumberOfItemId = 5
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnArArticlePriceId = 6
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnCalculatedAmountId = 7
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnCurrencyCodeId = 8
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnTaxTypeCodeId = 9
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnTaxRateCodeId = 10
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnTaxValidFromId = 11
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnDateCreatedId = 12
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnCreatedById = 13
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnDateModifiedId = 14
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnModifiedById = 15
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnModificationIdId = 16
 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

AArInvoiceDetailRow 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

an invoice consists of one or more details

Constructor & Destructor Documentation

◆ AArInvoiceDetailTable() [1/3]

Ict.Petra.Shared.MFinance.AR.Data.AArInvoiceDetailTable.AArInvoiceDetailTable ( )
inline

constructor

◆ AArInvoiceDetailTable() [2/3]

Ict.Petra.Shared.MFinance.AR.Data.AArInvoiceDetailTable.AArInvoiceDetailTable ( string  ATablename)
inline

constructor

◆ AArInvoiceDetailTable() [3/3]

Ict.Petra.Shared.MFinance.AR.Data.AArInvoiceDetailTable.AArInvoiceDetailTable ( 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.AR.Data.AArInvoiceDetailTable.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

◆ GetArArticleCodeDBName()

static string Ict.Petra.Shared.MFinance.AR.Data.AArInvoiceDetailTable.GetArArticleCodeDBName ( )
inlinestatic

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

◆ GetArArticleCodeHelp()

static string Ict.Petra.Shared.MFinance.AR.Data.AArInvoiceDetailTable.GetArArticleCodeHelp ( )
inlinestatic

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

◆ GetArArticleCodeLength()

static short Ict.Petra.Shared.MFinance.AR.Data.AArInvoiceDetailTable.GetArArticleCodeLength ( )
inlinestatic

get character length for column

◆ GetArArticlePriceDBName()

static string Ict.Petra.Shared.MFinance.AR.Data.AArInvoiceDetailTable.GetArArticlePriceDBName ( )
inlinestatic

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

◆ GetArArticlePriceHelp()

static string Ict.Petra.Shared.MFinance.AR.Data.AArInvoiceDetailTable.GetArArticlePriceHelp ( )
inlinestatic

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

◆ GetArArticlePriceLength()

static short Ict.Petra.Shared.MFinance.AR.Data.AArInvoiceDetailTable.GetArArticlePriceLength ( )
inlinestatic

get character length for column

◆ GetArNumberOfItemDBName()

static string Ict.Petra.Shared.MFinance.AR.Data.AArInvoiceDetailTable.GetArNumberOfItemDBName ( )
inlinestatic

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

◆ GetArNumberOfItemHelp()

static string Ict.Petra.Shared.MFinance.AR.Data.AArInvoiceDetailTable.GetArNumberOfItemHelp ( )
inlinestatic

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

◆ GetArNumberOfItemLength()

static short Ict.Petra.Shared.MFinance.AR.Data.AArInvoiceDetailTable.GetArNumberOfItemLength ( )
inlinestatic

get character length for column

◆ GetArReferenceDBName()

static string Ict.Petra.Shared.MFinance.AR.Data.AArInvoiceDetailTable.GetArReferenceDBName ( )
inlinestatic

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

◆ GetArReferenceHelp()

static string Ict.Petra.Shared.MFinance.AR.Data.AArInvoiceDetailTable.GetArReferenceHelp ( )
inlinestatic

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

◆ GetArReferenceLength()

static short Ict.Petra.Shared.MFinance.AR.Data.AArInvoiceDetailTable.GetArReferenceLength ( )
inlinestatic

get character length for column

◆ GetCalculatedAmountDBName()

static string Ict.Petra.Shared.MFinance.AR.Data.AArInvoiceDetailTable.GetCalculatedAmountDBName ( )
inlinestatic

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

◆ GetCalculatedAmountHelp()

static string Ict.Petra.Shared.MFinance.AR.Data.AArInvoiceDetailTable.GetCalculatedAmountHelp ( )
inlinestatic

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

◆ GetCalculatedAmountLength()

static short Ict.Petra.Shared.MFinance.AR.Data.AArInvoiceDetailTable.GetCalculatedAmountLength ( )
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()

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

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

◆ GetCreatedByHelp()

static string Ict.Petra.Shared.MFinance.AR.Data.AArInvoiceDetailTable.GetCreatedByHelp ( )
inlinestatic

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

◆ GetCreatedByLength()

static short Ict.Petra.Shared.MFinance.AR.Data.AArInvoiceDetailTable.GetCreatedByLength ( )
inlinestatic

get character length for column

◆ GetCurrencyCodeDBName()

static string Ict.Petra.Shared.MFinance.AR.Data.AArInvoiceDetailTable.GetCurrencyCodeDBName ( )
inlinestatic

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

◆ GetCurrencyCodeHelp()

static string Ict.Petra.Shared.MFinance.AR.Data.AArInvoiceDetailTable.GetCurrencyCodeHelp ( )
inlinestatic

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

◆ GetCurrencyCodeLength()

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

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

◆ GetDateCreatedHelp()

static string Ict.Petra.Shared.MFinance.AR.Data.AArInvoiceDetailTable.GetDateCreatedHelp ( )
inlinestatic

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

◆ GetDateCreatedLength()

static short Ict.Petra.Shared.MFinance.AR.Data.AArInvoiceDetailTable.GetDateCreatedLength ( )
inlinestatic

get character length for column

◆ GetDateModifiedDBName()

static string Ict.Petra.Shared.MFinance.AR.Data.AArInvoiceDetailTable.GetDateModifiedDBName ( )
inlinestatic

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

◆ GetDateModifiedHelp()

static string Ict.Petra.Shared.MFinance.AR.Data.AArInvoiceDetailTable.GetDateModifiedHelp ( )
inlinestatic

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

◆ GetDateModifiedLength()

static short Ict.Petra.Shared.MFinance.AR.Data.AArInvoiceDetailTable.GetDateModifiedLength ( )
inlinestatic

get character length for column

◆ GetDetailNumberDBName()

static string Ict.Petra.Shared.MFinance.AR.Data.AArInvoiceDetailTable.GetDetailNumberDBName ( )
inlinestatic

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

◆ GetDetailNumberHelp()

static string Ict.Petra.Shared.MFinance.AR.Data.AArInvoiceDetailTable.GetDetailNumberHelp ( )
inlinestatic

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

◆ GetDetailNumberLength()

static short Ict.Petra.Shared.MFinance.AR.Data.AArInvoiceDetailTable.GetDetailNumberLength ( )
inlinestatic

get character length for column

◆ GetInvoiceKeyDBName()

static string Ict.Petra.Shared.MFinance.AR.Data.AArInvoiceDetailTable.GetInvoiceKeyDBName ( )
inlinestatic

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

◆ GetInvoiceKeyHelp()

static string Ict.Petra.Shared.MFinance.AR.Data.AArInvoiceDetailTable.GetInvoiceKeyHelp ( )
inlinestatic

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

◆ GetInvoiceKeyLength()

static short Ict.Petra.Shared.MFinance.AR.Data.AArInvoiceDetailTable.GetInvoiceKeyLength ( )
inlinestatic

get character length for column

◆ GetKeyColumnStringList()

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

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

◆ GetLabel()

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

returns the translated label for the column

◆ GetLedgerNumberDBName()

static string Ict.Petra.Shared.MFinance.AR.Data.AArInvoiceDetailTable.GetLedgerNumberDBName ( )
inlinestatic

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

◆ GetLedgerNumberHelp()

static string Ict.Petra.Shared.MFinance.AR.Data.AArInvoiceDetailTable.GetLedgerNumberHelp ( )
inlinestatic

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

◆ GetLedgerNumberLength()

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

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

◆ GetModificationIdHelp()

static string Ict.Petra.Shared.MFinance.AR.Data.AArInvoiceDetailTable.GetModificationIdHelp ( )
inlinestatic

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

◆ GetModificationIdLength()

static short Ict.Petra.Shared.MFinance.AR.Data.AArInvoiceDetailTable.GetModificationIdLength ( )
inlinestatic

get character length for column

◆ GetModifiedByDBName()

static string Ict.Petra.Shared.MFinance.AR.Data.AArInvoiceDetailTable.GetModifiedByDBName ( )
inlinestatic

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

◆ GetModifiedByHelp()

static string Ict.Petra.Shared.MFinance.AR.Data.AArInvoiceDetailTable.GetModifiedByHelp ( )
inlinestatic

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

◆ GetModifiedByLength()

static short Ict.Petra.Shared.MFinance.AR.Data.AArInvoiceDetailTable.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.AR.Data.AArInvoiceDetailTable.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.AR.Data.AArInvoiceDetailTable.GetTableDBName ( )
inlinestatic

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

◆ GetTableName() [1/2]

static string Ict.Petra.Shared.MFinance.AR.Data.AArInvoiceDetailTable.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

◆ GetTaxRateCodeDBName()

static string Ict.Petra.Shared.MFinance.AR.Data.AArInvoiceDetailTable.GetTaxRateCodeDBName ( )
inlinestatic

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

◆ GetTaxRateCodeHelp()

static string Ict.Petra.Shared.MFinance.AR.Data.AArInvoiceDetailTable.GetTaxRateCodeHelp ( )
inlinestatic

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

◆ GetTaxRateCodeLength()

static short Ict.Petra.Shared.MFinance.AR.Data.AArInvoiceDetailTable.GetTaxRateCodeLength ( )
inlinestatic

get character length for column

◆ GetTaxTypeCodeDBName()

static string Ict.Petra.Shared.MFinance.AR.Data.AArInvoiceDetailTable.GetTaxTypeCodeDBName ( )
inlinestatic

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

◆ GetTaxTypeCodeHelp()

static string Ict.Petra.Shared.MFinance.AR.Data.AArInvoiceDetailTable.GetTaxTypeCodeHelp ( )
inlinestatic

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

◆ GetTaxTypeCodeLength()

static short Ict.Petra.Shared.MFinance.AR.Data.AArInvoiceDetailTable.GetTaxTypeCodeLength ( )
inlinestatic

get character length for column

◆ GetTaxValidFromDBName()

static string Ict.Petra.Shared.MFinance.AR.Data.AArInvoiceDetailTable.GetTaxValidFromDBName ( )
inlinestatic

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

◆ GetTaxValidFromHelp()

static string Ict.Petra.Shared.MFinance.AR.Data.AArInvoiceDetailTable.GetTaxValidFromHelp ( )
inlinestatic

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

◆ GetTaxValidFromLength()

static short Ict.Petra.Shared.MFinance.AR.Data.AArInvoiceDetailTable.GetTaxValidFromLength ( )
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.AR.Data.AArInvoiceDetailTable.InitClass ( )
inlineprotectedvirtual

create the columns

Implements Ict.Common.Data.TTypedDataTable.

◆ InitVars()

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

new typed row using DataRowBuilder

◆ NewRowTyped() [1/2]

AArInvoiceDetailRow Ict.Petra.Shared.MFinance.AR.Data.AArInvoiceDetailTable.NewRowTyped ( )
inline

create a new typed row, always with default values

◆ NewRowTyped() [2/2]

AArInvoiceDetailRow Ict.Petra.Shared.MFinance.AR.Data.AArInvoiceDetailTable.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

◆ ColumnArArticleCode

DataColumn Ict.Petra.Shared.MFinance.AR.Data.AArInvoiceDetailTable.ColumnArArticleCode

code that uniquely identifies the item; can also be a code of a group of equally priced items

◆ ColumnArArticleCodeId

readonly short Ict.Petra.Shared.MFinance.AR.Data.AArInvoiceDetailTable.ColumnArArticleCodeId = 3
static

used for generic TTypedDataTable functions

◆ ColumnArArticlePrice

DataColumn Ict.Petra.Shared.MFinance.AR.Data.AArInvoiceDetailTable.ColumnArArticlePrice

Reference to the price that should be used for this article in this invoice, by date; without discounts, just for single item.

◆ ColumnArArticlePriceId

readonly short Ict.Petra.Shared.MFinance.AR.Data.AArInvoiceDetailTable.ColumnArArticlePriceId = 6
static

used for generic TTypedDataTable functions

◆ ColumnArNumberOfItem

DataColumn Ict.Petra.Shared.MFinance.AR.Data.AArInvoiceDetailTable.ColumnArNumberOfItem

defines the number of the article items that is bought

◆ ColumnArNumberOfItemId

readonly short Ict.Petra.Shared.MFinance.AR.Data.AArInvoiceDetailTable.ColumnArNumberOfItemId = 5
static

used for generic TTypedDataTable functions

◆ ColumnArReference

DataColumn Ict.Petra.Shared.MFinance.AR.Data.AArInvoiceDetailTable.ColumnArReference

Reference for this invoice detail; for a non specific article that could give more details (e.g. which book of type small book)

◆ ColumnArReferenceId

readonly short Ict.Petra.Shared.MFinance.AR.Data.AArInvoiceDetailTable.ColumnArReferenceId = 4
static

used for generic TTypedDataTable functions

◆ ColumnCalculatedAmount

DataColumn Ict.Petra.Shared.MFinance.AR.Data.AArInvoiceDetailTable.ColumnCalculatedAmount

The total amount of money that this invoice detail is worth; includes the discounts.

◆ ColumnCalculatedAmountId

readonly short Ict.Petra.Shared.MFinance.AR.Data.AArInvoiceDetailTable.ColumnCalculatedAmountId = 7
static

used for generic TTypedDataTable functions

◆ ColumnCreatedBy

DataColumn Ict.Petra.Shared.MFinance.AR.Data.AArInvoiceDetailTable.ColumnCreatedBy

User ID of who created this record.

◆ ColumnCreatedById

readonly short Ict.Petra.Shared.MFinance.AR.Data.AArInvoiceDetailTable.ColumnCreatedById = 13
static

used for generic TTypedDataTable functions

◆ ColumnCurrencyCode

DataColumn Ict.Petra.Shared.MFinance.AR.Data.AArInvoiceDetailTable.ColumnCurrencyCode

the currency of the total amount

◆ ColumnCurrencyCodeId

readonly short Ict.Petra.Shared.MFinance.AR.Data.AArInvoiceDetailTable.ColumnCurrencyCodeId = 8
static

used for generic TTypedDataTable functions

◆ ColumnDateCreated

DataColumn Ict.Petra.Shared.MFinance.AR.Data.AArInvoiceDetailTable.ColumnDateCreated

The date the record was created.

◆ ColumnDateCreatedId

readonly short Ict.Petra.Shared.MFinance.AR.Data.AArInvoiceDetailTable.ColumnDateCreatedId = 12
static

used for generic TTypedDataTable functions

◆ ColumnDateModified

DataColumn Ict.Petra.Shared.MFinance.AR.Data.AArInvoiceDetailTable.ColumnDateModified

The date the record was modified.

◆ ColumnDateModifiedId

readonly short Ict.Petra.Shared.MFinance.AR.Data.AArInvoiceDetailTable.ColumnDateModifiedId = 14
static

used for generic TTypedDataTable functions

◆ ColumnDetailNumber

DataColumn Ict.Petra.Shared.MFinance.AR.Data.AArInvoiceDetailTable.ColumnDetailNumber

A unique number for this detail for its invoice.

◆ ColumnDetailNumberId

readonly short Ict.Petra.Shared.MFinance.AR.Data.AArInvoiceDetailTable.ColumnDetailNumberId = 2
static

used for generic TTypedDataTable functions

◆ ColumnInvoiceKey

DataColumn Ict.Petra.Shared.MFinance.AR.Data.AArInvoiceDetailTable.ColumnInvoiceKey

this invoice detail belongs to the invoice with this key

◆ ColumnInvoiceKeyId

readonly short Ict.Petra.Shared.MFinance.AR.Data.AArInvoiceDetailTable.ColumnInvoiceKeyId = 1
static

used for generic TTypedDataTable functions

◆ ColumnLedgerNumber

DataColumn Ict.Petra.Shared.MFinance.AR.Data.AArInvoiceDetailTable.ColumnLedgerNumber

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

◆ ColumnLedgerNumberId

readonly short Ict.Petra.Shared.MFinance.AR.Data.AArInvoiceDetailTable.ColumnLedgerNumberId = 0
static

used for generic TTypedDataTable functions

◆ ColumnModificationId

DataColumn Ict.Petra.Shared.MFinance.AR.Data.AArInvoiceDetailTable.ColumnModificationId

This identifies the current version of the record.

◆ ColumnModificationIdId

readonly short Ict.Petra.Shared.MFinance.AR.Data.AArInvoiceDetailTable.ColumnModificationIdId = 16
static

used for generic TTypedDataTable functions

◆ ColumnModifiedBy

DataColumn Ict.Petra.Shared.MFinance.AR.Data.AArInvoiceDetailTable.ColumnModifiedBy

User ID of who last modified this record.

◆ ColumnModifiedById

readonly short Ict.Petra.Shared.MFinance.AR.Data.AArInvoiceDetailTable.ColumnModifiedById = 15
static

used for generic TTypedDataTable functions

◆ ColumnTaxRateCode

DataColumn Ict.Petra.Shared.MFinance.AR.Data.AArInvoiceDetailTable.ColumnTaxRateCode

this describes whether it is e.g. the standard, reduced or zero rate of VAT

◆ ColumnTaxRateCodeId

readonly short Ict.Petra.Shared.MFinance.AR.Data.AArInvoiceDetailTable.ColumnTaxRateCodeId = 10
static

used for generic TTypedDataTable functions

◆ ColumnTaxTypeCode

DataColumn Ict.Petra.Shared.MFinance.AR.Data.AArInvoiceDetailTable.ColumnTaxTypeCode

The tax type is always the same, e.g. VAT.

◆ ColumnTaxTypeCodeId

readonly short Ict.Petra.Shared.MFinance.AR.Data.AArInvoiceDetailTable.ColumnTaxTypeCodeId = 9
static

used for generic TTypedDataTable functions

◆ ColumnTaxValidFrom

DataColumn Ict.Petra.Shared.MFinance.AR.Data.AArInvoiceDetailTable.ColumnTaxValidFrom

we need to be able to pick a rate that was valid in the past or will be valid in the future

◆ ColumnTaxValidFromId

readonly short Ict.Petra.Shared.MFinance.AR.Data.AArInvoiceDetailTable.ColumnTaxValidFromId = 11
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.AR.Data.AArInvoiceDetailTable.TableId = 186
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.AR.Data.AArInvoiceDetailTable.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]

AArInvoiceDetailRow Ict.Petra.Shared.MFinance.AR.Data.AArInvoiceDetailTable.this[int i]
get

Access a typed row by index.


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