OSB_LIB::AccountInterface Class Reference

Inheritance diagram for OSB_LIB::AccountInterface:

Inheritance graph
List of all members.

Detailed Description

Accounting Interface.

This abstract base class defines the accounting interface to external accounting systems.

Definition at line 195 of file account.h.

Public Member Functions

Constructor & Destructor Documentation

virtual OSB_LIB::AccountInterface::~AccountInterface (  )  [inline, virtual]

Virtual destructor.

Definition at line 198 of file account.h.

Member Function Documentation

virtual bool OSB_LIB::AccountInterface::getBalance ( const Associate associate,
const DateTime ts,
MoneyList dest 
) [pure virtual]

Get the balance for an associate at a given date.

associate Associate for whom to get the balance.
ts Date and time of the balance, transactions at ts are not included.
dest List of (amount, currency) to populate. It is cleared inside the function.
true if any entries were written to dest, else false.

Implemented in OSB_LIB::AccountAr, and OSB_LIB::AccountImp.

virtual long OSB_LIB::AccountInterface::getDuedays ( const Associate associate  )  [pure virtual]

Get due days of an associate.

associate Associate.
Due days of this associate.

Implemented in OSB_LIB::AccountAr.

virtual long OSB_LIB::AccountInterface::readTransactions ( TransactionList transactions,
const Associate associate,
const DateTime start,
const DateTime end 
) [pure virtual]

Read transactions of a given associate for a specific time period.

Reads the transactions from the external accounting system into the transactions list container and returns the number of transactions read.

transactions Transactions.
associate Associate.
start Lower boundary of the time period.
end Upper boundary of the time period.
Number of transactions read.

Implemented in OSB_LIB::AccountAr, and OSB_LIB::AccountImp.

virtual bool OSB_LIB::AccountInterface::writeInvoice ( const Associate associate,
const Contract contract,
const InvoiceInfo invInfo 
) [pure virtual]

Write transaction data for an invoice to external accounting system.

This function can use all public attributes of the associate, contract and invoice passed as parameters to write detailed information about each created invoice to the accounting system.

associate Associate.
contract Contract.
invInfo Invoice.
True if the function was successful, false if it failed.

Implemented in OSB_LIB::AccountAr.

virtual long OSB_LIB::AccountInterface::writeTransactions ( const TransactionList transactions  )  [pure virtual]

Write transactions to external accounting system.

Writes the transactions supplied in the transaction list to the external accounting system. The Transaction type can store only the basic information about each transaction. If more data should be passed to the accounting system, use writeInvoice().

transactions List of transactions.
Number of transactions written.

Implemented in OSB_LIB::AccountAr, and OSB_LIB::AccountImp.

The documentation for this class was generated from the following file:
Generated on Sat Sep 2 14:10:34 2006 for OSB Library by  doxygen 1.4.7