OSB_LIB::AccountInterface Class Reference

Inheritance diagram for OSB_LIB::AccountInterface:

[legend]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

• virtual ~AccountInterface ()

  Virtual destructor.
  

• virtual bool getBalance (const Associate &associate, const DateTime &ts, MoneyList &dest)=0

  Get the balance for an associate at a given date.
  

• virtual long readTransactions (TransactionList &transactions, const Associate &associate, const DateTime &start, const DateTime &end)=0

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

• virtual long getDuedays (const Associate &associate)=0

  Get due days of an associate.
  

• virtual long writeTransactions (const TransactionList &transactions)=0

  Write transactions to external accounting system.
  

• virtual bool writeInvoice (const Associate &associate, const Contract &contract, const InvoiceInfo &invInfo)=0

  Write transaction data for an invoice to external accounting system.
  

---

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.

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.

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.

Parameters:

associate

Associate.

Returns:

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.

Parameters:

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

Returns:

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.

Parameters:

	associate	Associate.
	contract	Contract.
	invInfo	Invoice.

Returns:

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().

Parameters:

transactions

List of transactions.

Returns:

Number of transactions written.

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

---

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

• account.h

---