OpenPetra
Free Administration Software for Non-Profits
Ict.Petra.Server.MFinance.Common.WebConnectors.TCrossLedger Class Reference

This connector provides methods for working with the Cross-Ledger data /summary> More...

Static Public Member Functions

static ExchangeRateTDS LoadDailyExchangeRateData (bool ADeleteAgedExchangeRatesFirst)
 This is the main method to load all the data required by the Daily Exchange rate Setup screen. It slices and dices the exchange rate data in two ways: More...
 
static ExchangeRateTDS LoadDailyExchangeRateData (bool ADeleteAgedExchangeRatesFirst, DateTime AFromDate, DateTime AToDate)
 This is the main method to load all the data required by the Daily Exchange rate Setup screen. It slices and dices the exchange rate data in two ways: More...
 

Detailed Description

This connector provides methods for working with the Cross-Ledger data /summary>

Member Function Documentation

◆ LoadDailyExchangeRateData() [1/2]

static ExchangeRateTDS Ict.Petra.Server.MFinance.Common.WebConnectors.TCrossLedger.LoadDailyExchangeRateData ( bool  ADeleteAgedExchangeRatesFirst)
inlinestatic

This is the main method to load all the data required by the Daily Exchange rate Setup screen. It slices and dices the exchange rate data in two ways:

  1. It populates a table with all the rows from the daily exchange rate table itself, plus the data from the Journal and Gift tables as well that are not referenced by any of the daily rate table rows. Additionally this table contains two columns that show how many times the specified rate has been used. This table has one row for every defined rate. The rate may be used in more than one place. The primary key for this table (like the Daily Exchange Rate table itself) is From/To/Date/Time
  2. It populates another table with rate and date information in the same Daily Exchange Rate table format but this table is extended such that the row specifies the ledger/batch/journal details where this rate can be found. There is one row per place where a rate is used, so the same from/to/date/time may occur more than once, each with a different ledger/batch/journal. Typically this table has fewer rows than (1) because it does not contain any unused rows and it does not contain any inverse currency rows. The primary key is From/To/Date/Time/Ledger/Batch/Journal. The third table is the Corporate Exchange Rate table, which contains standard content
Parameters
ADeleteAgedExchangeRatesFirstSet this to true to purge 'aged' unused or duplicate exchange rates from the database before returning the DataSet
Returns
A complete typed data set containing three tables.

◆ LoadDailyExchangeRateData() [2/2]

static ExchangeRateTDS Ict.Petra.Server.MFinance.Common.WebConnectors.TCrossLedger.LoadDailyExchangeRateData ( bool  ADeleteAgedExchangeRatesFirst,
DateTime  AFromDate,
DateTime  AToDate 
)
inlinestatic

This is the main method to load all the data required by the Daily Exchange rate Setup screen. It slices and dices the exchange rate data in two ways:

  1. It populates a table with all the rows from the daily exchange rate table itself, plus the data from the Journal and Gift tables as well that are not referenced by any of the daily rate table rows. Additionally this table contains two columns that show how many times the specified rate has been used. This table has one row for every defined rate. The rate may be used in more than one place. The primary key for this table (like the Daily Exchange Rate table itself) is From/To/Date/Time
  2. It populates another table with rate and date information in the same Daily Exchange Rate table format but this table is extended such that the row specifies the ledger/batch/journal details where this rate can be found. There is one row per place where a rate is used, so the same from/to/date/time may occur more than once, each with a different ledger/batch/journal. Typically this table has fewer rows than (1) because it does not contain any unused rows and it does not contain any inverse currency rows. The primary key is From/To/Date/Time/Ledger/Batch/Journal. The third table is the Corporate Exchange Rate table, which contains standard content
Parameters
ADeleteAgedExchangeRatesFirstSet this to true to purge 'aged' unused or duplicate exchange rates from the database before returning the DataSet
AFromDateA start date for the returned data set. THis date will be included
AToDateAn end date for the returned data set. THis date will be included
Returns
A complete typed data set containing three tables.

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