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

Either an invoice or a credit note in the Accounts Payable system. More...

Inheritance diagram for Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable:
Ict.Common.Data.TTypedDataTable Ict.Petra.Shared.MFinance.AP.Data.AccountsPayableTDSAApDocumentTable

Public Member Functions

 AApDocumentTable ()
 constructor More...
 
 AApDocumentTable (string ATablename)
 constructor More...
 
 AApDocumentTable (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...
 
AApDocumentRow NewRowTyped (bool AWithDefaultValues)
 create a new typed row More...
 
AApDocumentRow NewRowTyped ()
 create a new typed row, always with default values More...
 
AApDocumentTable 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 GetApDocumentIdDBName ()
 get the name of the field in the database for this column More...
 
static short GetApDocumentIdLength ()
 get character length for column More...
 
static string GetApDocumentIdHelp ()
 get the help text for the field in the database for this column More...
 
static string GetLedgerNumberDBName ()
 get the name of the field in the database for this column More...
 
static short GetLedgerNumberLength ()
 get character length for column More...
 
static string GetLedgerNumberHelp ()
 get the help text for the field in the database for this column More...
 
static string GetApNumberDBName ()
 get the name of the field in the database for this column More...
 
static short GetApNumberLength ()
 get character length for column More...
 
static string GetApNumberHelp ()
 get the help text for the field in the database for this column More...
 
static string GetPartnerKeyDBName ()
 get the name of the field in the database for this column More...
 
static short GetPartnerKeyLength ()
 get character length for column More...
 
static string GetPartnerKeyHelp ()
 get the help text for the field in the database for this column More...
 
static string GetCreditNoteFlagDBName ()
 get the name of the field in the database for this column More...
 
static short GetCreditNoteFlagLength ()
 get character length for column More...
 
static string GetCreditNoteFlagHelp ()
 get the help text for the field in the database for this column More...
 
static string GetDocumentCodeDBName ()
 get the name of the field in the database for this column More...
 
static short GetDocumentCodeLength ()
 get character length for column More...
 
static string GetDocumentCodeHelp ()
 get the help text for the field in the database for this column More...
 
static string GetReferenceDBName ()
 get the name of the field in the database for this column More...
 
static short GetReferenceLength ()
 get character length for column More...
 
static string GetReferenceHelp ()
 get the help text for the field in the database for this column More...
 
static string GetDateIssuedDBName ()
 get the name of the field in the database for this column More...
 
static short GetDateIssuedLength ()
 get character length for column More...
 
static string GetDateIssuedHelp ()
 get the help text for the field in the database for this column More...
 
static string GetDateEnteredDBName ()
 get the name of the field in the database for this column More...
 
static short GetDateEnteredLength ()
 get character length for column More...
 
static string GetDateEnteredHelp ()
 get the help text for the field in the database for this column More...
 
static string GetCreditTermsDBName ()
 get the name of the field in the database for this column More...
 
static short GetCreditTermsLength ()
 get character length for column More...
 
static string GetCreditTermsHelp ()
 get the help text for the field in the database for this column More...
 
static string GetTotalAmountDBName ()
 get the name of the field in the database for this column More...
 
static short GetTotalAmountLength ()
 get character length for column More...
 
static string GetTotalAmountHelp ()
 get the help text for the field in the database for this column More...
 
static string GetCurrencyCodeDBName ()
 get the name of the field in the database for this column More...
 
static short GetCurrencyCodeLength ()
 get character length for column More...
 
static string GetCurrencyCodeHelp ()
 get the help text for the field in the database for this column More...
 
static string GetExchangeRateToBaseDBName ()
 get the name of the field in the database for this column More...
 
static short GetExchangeRateToBaseLength ()
 get character length for column More...
 
static string GetExchangeRateToBaseHelp ()
 get the help text for the field in the database for this column More...
 
static string GetDiscountPercentageDBName ()
 get the name of the field in the database for this column More...
 
static short GetDiscountPercentageLength ()
 get character length for column More...
 
static string GetDiscountPercentageHelp ()
 get the help text for the field in the database for this column More...
 
static string GetDiscountDaysDBName ()
 get the name of the field in the database for this column More...
 
static short GetDiscountDaysLength ()
 get character length for column More...
 
static string GetDiscountDaysHelp ()
 get the help text for the field in the database for this column More...
 
static string GetApAccountDBName ()
 get the name of the field in the database for this column More...
 
static short GetApAccountLength ()
 get character length for column More...
 
static string GetApAccountHelp ()
 get the help text for the field in the database for this column More...
 
static string GetLastDetailNumberDBName ()
 get the name of the field in the database for this column More...
 
static short GetLastDetailNumberLength ()
 get character length for column More...
 
static string GetLastDetailNumberHelp ()
 get the help text for the field in the database for this column More...
 
static string GetDocumentStatusDBName ()
 get the name of the field in the database for this column More...
 
static short GetDocumentStatusLength ()
 get character length for column More...
 
static string GetDocumentStatusHelp ()
 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 ColumnApDocumentId
 Unique key for this record. More...
 
DataColumn ColumnLedgerNumber
 Reference to the ledger for this invoice. More...
 
DataColumn ColumnApNumber
 A unique key (together with the ledger number) to identify this document. More...
 
DataColumn ColumnPartnerKey
 Reference to the supplier that sent this invoice. More...
 
DataColumn ColumnCreditNoteFlag
 A flag to indicate if this document is an invoice or a credit note. More...
 
DataColumn ColumnDocumentCode
 The code given on the document itself (be it invoice or credit note). This will have to be unique for each supplier. More...
 
DataColumn ColumnReference
 Some kind of other reference needed. More...
 
DataColumn ColumnDateIssued
 The date when this document was issued. More...
 
DataColumn ColumnDateEntered
 The date when this document was entered into the system. More...
 
DataColumn ColumnCreditTerms
 Credit terms allowed for this invoice. More...
 
DataColumn ColumnTotalAmount
 The total amount of money that this document is worth. More...
 
DataColumn ColumnCurrencyCode
 the currency of the document More...
 
DataColumn ColumnExchangeRateToBase
 The exchange rate to the base currency at the time that the document was issued. More...
 
DataColumn ColumnDiscountPercentage
 The percentage discount you get for early payment of this document in the case that it is an invoice. More...
 
DataColumn ColumnDiscountDays
 The number of days that the discount is valid for (0 for none). More...
 
DataColumn ColumnApAccount
 Reference to the AP Account to debit/credit when posting/paying the document. More...
 
DataColumn ColumnLastDetailNumber
 The number of the last item for this document. This is used simply to quickly get the next number if items are added. More...
 
DataColumn ColumnDocumentStatus
 The current status of the invoice. The value can (for now) be one of: OPEN, APPROVED, POSTED, PARTPAID, or PAID. 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 = 171
 TableId for Ict.Common.Data generic functions. More...
 
static readonly short ColumnApDocumentIdId = 0
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnLedgerNumberId = 1
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnApNumberId = 2
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnPartnerKeyId = 3
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnCreditNoteFlagId = 4
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnDocumentCodeId = 5
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnReferenceId = 6
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnDateIssuedId = 7
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnDateEnteredId = 8
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnCreditTermsId = 9
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnTotalAmountId = 10
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnCurrencyCodeId = 11
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnExchangeRateToBaseId = 12
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnDiscountPercentageId = 13
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnDiscountDaysId = 14
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnApAccountId = 15
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnLastDetailNumberId = 16
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnDocumentStatusId = 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

AApDocumentRow 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

Either an invoice or a credit note in the Accounts Payable system.

Constructor & Destructor Documentation

◆ AApDocumentTable() [1/3]

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

constructor

◆ AApDocumentTable() [2/3]

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

constructor

◆ AApDocumentTable() [3/3]

Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.AApDocumentTable ( System.Runtime.Serialization.SerializationInfo  info,
System.Runtime.Serialization.StreamingContext  context 
)
inline

constructor for serialization

Member Function Documentation

◆ CreateOdbcParameter() [1/3]

override OdbcParameter Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.CreateOdbcParameter ( Int32  AColumnNr)
inlinevirtual

get an odbc parameter for the given column

Implements Ict.Common.Data.TTypedDataTable.

Reimplemented in Ict.Petra.Shared.MFinance.AP.Data.AccountsPayableTDSAApDocumentTable.

◆ 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

◆ GetApAccountDBName()

static string Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.GetApAccountDBName ( )
inlinestatic

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

◆ GetApAccountHelp()

static string Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.GetApAccountHelp ( )
inlinestatic

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

◆ GetApAccountLength()

static short Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.GetApAccountLength ( )
inlinestatic

get character length for column

◆ GetApDocumentIdDBName()

static string Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.GetApDocumentIdDBName ( )
inlinestatic

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

◆ GetApDocumentIdHelp()

static string Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.GetApDocumentIdHelp ( )
inlinestatic

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

◆ GetApDocumentIdLength()

static short Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.GetApDocumentIdLength ( )
inlinestatic

get character length for column

◆ GetApNumberDBName()

static string Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.GetApNumberDBName ( )
inlinestatic

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

◆ GetApNumberHelp()

static string Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.GetApNumberHelp ( )
inlinestatic

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

◆ GetApNumberLength()

static short Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.GetApNumberLength ( )
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()

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

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

◆ GetCreatedByHelp()

static string Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.GetCreatedByHelp ( )
inlinestatic

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

◆ GetCreatedByLength()

static short Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.GetCreatedByLength ( )
inlinestatic

get character length for column

◆ GetCreditNoteFlagDBName()

static string Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.GetCreditNoteFlagDBName ( )
inlinestatic

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

◆ GetCreditNoteFlagHelp()

static string Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.GetCreditNoteFlagHelp ( )
inlinestatic

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

◆ GetCreditNoteFlagLength()

static short Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.GetCreditNoteFlagLength ( )
inlinestatic

get character length for column

◆ GetCreditTermsDBName()

static string Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.GetCreditTermsDBName ( )
inlinestatic

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

◆ GetCreditTermsHelp()

static string Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.GetCreditTermsHelp ( )
inlinestatic

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

◆ GetCreditTermsLength()

static short Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.GetCreditTermsLength ( )
inlinestatic

get character length for column

◆ GetCurrencyCodeDBName()

static string Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.GetCurrencyCodeDBName ( )
inlinestatic

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

◆ GetCurrencyCodeHelp()

static string Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.GetCurrencyCodeHelp ( )
inlinestatic

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

◆ GetCurrencyCodeLength()

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

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

◆ GetDateCreatedHelp()

static string Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.GetDateCreatedHelp ( )
inlinestatic

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

◆ GetDateCreatedLength()

static short Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.GetDateCreatedLength ( )
inlinestatic

get character length for column

◆ GetDateEnteredDBName()

static string Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.GetDateEnteredDBName ( )
inlinestatic

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

◆ GetDateEnteredHelp()

static string Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.GetDateEnteredHelp ( )
inlinestatic

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

◆ GetDateEnteredLength()

static short Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.GetDateEnteredLength ( )
inlinestatic

get character length for column

◆ GetDateIssuedDBName()

static string Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.GetDateIssuedDBName ( )
inlinestatic

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

◆ GetDateIssuedHelp()

static string Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.GetDateIssuedHelp ( )
inlinestatic

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

◆ GetDateIssuedLength()

static short Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.GetDateIssuedLength ( )
inlinestatic

get character length for column

◆ GetDateModifiedDBName()

static string Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.GetDateModifiedDBName ( )
inlinestatic

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

◆ GetDateModifiedHelp()

static string Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.GetDateModifiedHelp ( )
inlinestatic

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

◆ GetDateModifiedLength()

static short Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.GetDateModifiedLength ( )
inlinestatic

get character length for column

◆ GetDiscountDaysDBName()

static string Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.GetDiscountDaysDBName ( )
inlinestatic

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

◆ GetDiscountDaysHelp()

static string Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.GetDiscountDaysHelp ( )
inlinestatic

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

◆ GetDiscountDaysLength()

static short Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.GetDiscountDaysLength ( )
inlinestatic

get character length for column

◆ GetDiscountPercentageDBName()

static string Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.GetDiscountPercentageDBName ( )
inlinestatic

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

◆ GetDiscountPercentageHelp()

static string Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.GetDiscountPercentageHelp ( )
inlinestatic

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

◆ GetDiscountPercentageLength()

static short Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.GetDiscountPercentageLength ( )
inlinestatic

get character length for column

◆ GetDocumentCodeDBName()

static string Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.GetDocumentCodeDBName ( )
inlinestatic

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

◆ GetDocumentCodeHelp()

static string Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.GetDocumentCodeHelp ( )
inlinestatic

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

◆ GetDocumentCodeLength()

static short Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.GetDocumentCodeLength ( )
inlinestatic

get character length for column

◆ GetDocumentStatusDBName()

static string Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.GetDocumentStatusDBName ( )
inlinestatic

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

◆ GetDocumentStatusHelp()

static string Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.GetDocumentStatusHelp ( )
inlinestatic

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

◆ GetDocumentStatusLength()

static short Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.GetDocumentStatusLength ( )
inlinestatic

get character length for column

◆ GetExchangeRateToBaseDBName()

static string Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.GetExchangeRateToBaseDBName ( )
inlinestatic

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

◆ GetExchangeRateToBaseHelp()

static string Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.GetExchangeRateToBaseHelp ( )
inlinestatic

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

◆ GetExchangeRateToBaseLength()

static short Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.GetExchangeRateToBaseLength ( )
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

◆ GetLastDetailNumberDBName()

static string Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.GetLastDetailNumberDBName ( )
inlinestatic

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

◆ GetLastDetailNumberHelp()

static string Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.GetLastDetailNumberHelp ( )
inlinestatic

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

◆ GetLastDetailNumberLength()

static short Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.GetLastDetailNumberLength ( )
inlinestatic

get character length for column

◆ GetLedgerNumberDBName()

static string Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.GetLedgerNumberDBName ( )
inlinestatic

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

◆ GetLedgerNumberHelp()

static string Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.GetLedgerNumberHelp ( )
inlinestatic

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

◆ GetLedgerNumberLength()

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

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

◆ GetModificationIdHelp()

static string Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.GetModificationIdHelp ( )
inlinestatic

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

◆ GetModificationIdLength()

static short Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.GetModificationIdLength ( )
inlinestatic

get character length for column

◆ GetModifiedByDBName()

static string Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.GetModifiedByDBName ( )
inlinestatic

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

◆ GetModifiedByHelp()

static string Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.GetModifiedByHelp ( )
inlinestatic

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

◆ GetModifiedByLength()

static short Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.GetModifiedByLength ( )
inlinestatic

get character length for column

◆ GetPartnerKeyDBName()

static string Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.GetPartnerKeyDBName ( )
inlinestatic

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

◆ GetPartnerKeyHelp()

static string Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.GetPartnerKeyHelp ( )
inlinestatic

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

◆ GetPartnerKeyLength()

static short Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.GetPartnerKeyLength ( )
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

◆ GetReferenceDBName()

static string Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.GetReferenceDBName ( )
inlinestatic

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

◆ GetReferenceHelp()

static string Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.GetReferenceHelp ( )
inlinestatic

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

◆ GetReferenceLength()

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

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

◆ GetTableName() [1/2]

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

◆ GetTotalAmountDBName()

static string Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.GetTotalAmountDBName ( )
inlinestatic

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

◆ GetTotalAmountHelp()

static string Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.GetTotalAmountHelp ( )
inlinestatic

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

◆ GetTotalAmountLength()

static short Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.GetTotalAmountLength ( )
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.AP.Data.AApDocumentTable.InitClass ( )
inlineprotectedvirtual

◆ InitVars()

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

assign columns to properties, set primary key

Implements Ict.Common.Data.TTypedDataTable.

Reimplemented in Ict.Petra.Shared.MFinance.AP.Data.AccountsPayableTDSAApDocumentTable.

◆ IsAvailableForCustomReport()

virtual bool Ict.Common.Data.TTypedDataTable.IsAvailableForCustomReport ( )
inlinevirtualinherited

Is this table generally available in custom reports?

◆ NewRowFromBuilder()

override System.Data.DataRow Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.NewRowFromBuilder ( System.Data.DataRowBuilder  builder)
inlineprotected

new typed row using DataRowBuilder

◆ NewRowTyped() [1/2]

AApDocumentRow Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.NewRowTyped ( )
inline

create a new typed row, always with default values

◆ NewRowTyped() [2/2]

AApDocumentRow Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.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

◆ ColumnApAccount

DataColumn Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.ColumnApAccount

Reference to the AP Account to debit/credit when posting/paying the document.

◆ ColumnApAccountId

readonly short Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.ColumnApAccountId = 15
static

used for generic TTypedDataTable functions

◆ ColumnApDocumentId

DataColumn Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.ColumnApDocumentId

Unique key for this record.

◆ ColumnApDocumentIdId

readonly short Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.ColumnApDocumentIdId = 0
static

used for generic TTypedDataTable functions

◆ ColumnApNumber

DataColumn Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.ColumnApNumber

A unique key (together with the ledger number) to identify this document.

◆ ColumnApNumberId

readonly short Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.ColumnApNumberId = 2
static

used for generic TTypedDataTable functions

◆ ColumnCreatedBy

DataColumn Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.ColumnCreatedBy

User ID of who created this record.

◆ ColumnCreatedById

readonly short Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.ColumnCreatedById = 19
static

used for generic TTypedDataTable functions

◆ ColumnCreditNoteFlag

DataColumn Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.ColumnCreditNoteFlag

A flag to indicate if this document is an invoice or a credit note.

◆ ColumnCreditNoteFlagId

readonly short Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.ColumnCreditNoteFlagId = 4
static

used for generic TTypedDataTable functions

◆ ColumnCreditTerms

DataColumn Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.ColumnCreditTerms

Credit terms allowed for this invoice.

◆ ColumnCreditTermsId

readonly short Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.ColumnCreditTermsId = 9
static

used for generic TTypedDataTable functions

◆ ColumnCurrencyCode

DataColumn Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.ColumnCurrencyCode

the currency of the document

◆ ColumnCurrencyCodeId

readonly short Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.ColumnCurrencyCodeId = 11
static

used for generic TTypedDataTable functions

◆ ColumnDateCreated

DataColumn Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.ColumnDateCreated

The date the record was created.

◆ ColumnDateCreatedId

readonly short Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.ColumnDateCreatedId = 18
static

used for generic TTypedDataTable functions

◆ ColumnDateEntered

DataColumn Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.ColumnDateEntered

The date when this document was entered into the system.

◆ ColumnDateEnteredId

readonly short Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.ColumnDateEnteredId = 8
static

used for generic TTypedDataTable functions

◆ ColumnDateIssued

DataColumn Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.ColumnDateIssued

The date when this document was issued.

◆ ColumnDateIssuedId

readonly short Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.ColumnDateIssuedId = 7
static

used for generic TTypedDataTable functions

◆ ColumnDateModified

DataColumn Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.ColumnDateModified

The date the record was modified.

◆ ColumnDateModifiedId

readonly short Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.ColumnDateModifiedId = 20
static

used for generic TTypedDataTable functions

◆ ColumnDiscountDays

DataColumn Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.ColumnDiscountDays

The number of days that the discount is valid for (0 for none).

◆ ColumnDiscountDaysId

readonly short Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.ColumnDiscountDaysId = 14
static

used for generic TTypedDataTable functions

◆ ColumnDiscountPercentage

DataColumn Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.ColumnDiscountPercentage

The percentage discount you get for early payment of this document in the case that it is an invoice.

◆ ColumnDiscountPercentageId

readonly short Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.ColumnDiscountPercentageId = 13
static

used for generic TTypedDataTable functions

◆ ColumnDocumentCode

DataColumn Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.ColumnDocumentCode

The code given on the document itself (be it invoice or credit note). This will have to be unique for each supplier.

◆ ColumnDocumentCodeId

readonly short Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.ColumnDocumentCodeId = 5
static

used for generic TTypedDataTable functions

◆ ColumnDocumentStatus

DataColumn Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.ColumnDocumentStatus

The current status of the invoice. The value can (for now) be one of: OPEN, APPROVED, POSTED, PARTPAID, or PAID.

◆ ColumnDocumentStatusId

readonly short Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.ColumnDocumentStatusId = 17
static

used for generic TTypedDataTable functions

◆ ColumnExchangeRateToBase

DataColumn Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.ColumnExchangeRateToBase

The exchange rate to the base currency at the time that the document was issued.

◆ ColumnExchangeRateToBaseId

readonly short Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.ColumnExchangeRateToBaseId = 12
static

used for generic TTypedDataTable functions

◆ ColumnLastDetailNumber

DataColumn Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.ColumnLastDetailNumber

The number of the last item for this document. This is used simply to quickly get the next number if items are added.

◆ ColumnLastDetailNumberId

readonly short Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.ColumnLastDetailNumberId = 16
static

used for generic TTypedDataTable functions

◆ ColumnLedgerNumber

DataColumn Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.ColumnLedgerNumber

Reference to the ledger for this invoice.

◆ ColumnLedgerNumberId

readonly short Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.ColumnLedgerNumberId = 1
static

used for generic TTypedDataTable functions

◆ ColumnModificationId

DataColumn Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.ColumnModificationId

This identifies the current version of the record.

◆ ColumnModificationIdId

readonly short Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.ColumnModificationIdId = 22
static

used for generic TTypedDataTable functions

◆ ColumnModifiedBy

DataColumn Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.ColumnModifiedBy

User ID of who last modified this record.

◆ ColumnModifiedById

readonly short Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.ColumnModifiedById = 21
static

used for generic TTypedDataTable functions

◆ ColumnPartnerKey

DataColumn Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.ColumnPartnerKey

Reference to the supplier that sent this invoice.

◆ ColumnPartnerKeyId

readonly short Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.ColumnPartnerKeyId = 3
static

used for generic TTypedDataTable functions

◆ ColumnReference

DataColumn Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.ColumnReference

Some kind of other reference needed.

◆ ColumnReferenceId

readonly short Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.ColumnReferenceId = 6
static

used for generic TTypedDataTable functions

◆ ColumnTotalAmount

DataColumn Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.ColumnTotalAmount

The total amount of money that this document is worth.

◆ ColumnTotalAmountId

readonly short Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.ColumnTotalAmountId = 10
static

used for generic TTypedDataTable functions

◆ DontThrowAwayAfterSubmitChanges

bool Ict.Common.Data.TTypedDataTable.DontThrowAwayAfterSubmitChanges = false
inherited

if you want no warning about that the datatable should be cleared after submitchanges. in some cases you must keep the data, eg when you need the new keys after INSERT

◆ TableId

readonly short Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.TableId = 171
static

TableId for Ict.Common.Data generic functions.

◆ TableInfo

SortedList<short, TTypedTableInfo> Ict.Common.Data.TTypedDataTable.TableInfo = new SortedList <short, TTypedTableInfo>()
staticprotectedinherited

stores information about typed tables

◆ ThrowAwayAfterSubmitChanges

bool Ict.Common.Data.TTypedDataTable.ThrowAwayAfterSubmitChanges = false
inherited

if you want the datatable to be cleared after submitchanges. This will increase the speed significantly: no updating of modificationID, no slow AcceptChanges.

Property Documentation

◆ Count

int Ict.Common.Data.TTypedDataTable.Count
getinherited

the number of rows in the current table

◆ TableDBLabel

override string Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.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]

AApDocumentRow Ict.Petra.Shared.MFinance.AP.Data.AApDocumentTable.this[int i]
get

Access a typed row by index.


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