OSB_LIB::AccountAr Class Reference

Inheritance diagram for OSB_LIB::AccountAr:

Inheritance graph
[legend]
Collaboration diagram for OSB_LIB::AccountAr:

Collaboration graph
[legend]
List of all members.

Detailed Description

Accounting Interface integrate with AR.

This class is derived from AccountInterface class which is an abstract base class.

Definition at line 55 of file accountar.h.

Public Member Functions

Private Attributes


Constructor & Destructor Documentation

OSB_LIB::AccountAr::AccountAr ( OSB_DB::Session s  )  [inline]

Constructor: session is for access oracle.

Definition at line 58 of file accountar.h.


Member Function Documentation

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

Get the balance for an associate at a given date.

Parameters:
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.
Returns:
true if any entries were written to dest, else false.

Implements OSB_LIB::AccountInterface.

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

Get due days of an associate.

Parameters:
associate Associate.
Returns:
Due days of this associate.

Implements OSB_LIB::AccountInterface.

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

Read transactions from a period.

This virtual function will get a list of particular associate's payment transactions from a period.

Parameters:
transactions Transaction list to be populated.
associate Associate.
start Last bill date and time
end This bill date and time.
Returns:
Number of transaction read.

Implements OSB_LIB::AccountInterface.

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

Write invoice to external accounting system.

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

Parameters:
associate Associate.
contract Contract.
invInfo Information of invoice.
Returns:
True if the function was successful, false if it failed.

Implements OSB_LIB::AccountInterface.

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

Write the transactions to AR.

The AR system does neither support something like a transaction list nor is the current balance of an account maintained in the database: the function returns immediately without effect, nothing is actually written to the AR system.

Parameters:
transactions Transaction list.
Returns:
The function just returns the number of entries in transactions.

Implements OSB_LIB::AccountInterface.


Member Data Documentation

OSB_DB::Session* OSB_LIB::AccountAr::session_ [private]

Session for access oracle.

Definition at line 134 of file accountar.h.


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