OSB_DB::AccountArGw Class Reference

List of all members.

---

Detailed Description

Database Gateway to access data of AR.

Definition at line 59 of file accountar-gw.h.

Public Member Functions

• AccountArGw ()

  Default constructor.
  

• void fetchBalance (const Session &session, const OSB_LIB::Associate &associate, const OSB_LIB::DateTime &ts, OSB_LIB::MoneyList &dest)

  Get the balance for an associate at a given date.
  

• long fetchTransactions (OSB_LIB::TransactionList &transactions, const Session &session, const OSB_LIB::Associate &associate, const OSB_LIB::DateTime &start, const OSB_LIB::DateTime &end)

  Load the payment transactions.
  

• long fetchDuedays (const Session &session, const OSB_LIB::Associate &associate)

  Load the due days.
  

• bool updateInvoice (const Session &session, const OSB_LIB::Associate &associate, const OSB_LIB::Contract &contract, const OSB_LIB::InvoiceInfo &invInfo)

  Update the invoice transaction for AR.
  

Private Member Functions

• AccountArGw (const AccountArGw &rhs)

  Prevent copying: Copy constructor not implemented.
  

• AccountArGw & operator= (const AccountArGw &rhs)

  Prevent assignment: Assignment not implemented.
  

---

Constructor & Destructor Documentation

OSB_DB::AccountArGw::AccountArGw

(

const AccountArGw &

rhs

)

[private]

Prevent copying: Copy constructor not implemented.

OSB_DB::AccountArGw::AccountArGw

(

)

[inline]

Default constructor.

Definition at line 66 of file accountar-gw.h.

---

Member Function Documentation

void OSB_DB::AccountArGw::fetchBalance	(	const Session &	session,
		const OSB_LIB::Associate &	associate,
		const OSB_LIB::DateTime &	ts,
		OSB_LIB::MoneyList &	dest
	)

Get the balance for an associate at a given date.

Parameters:

	session	Database session to use.
	associate	Associate for who to get the balance.
	ts	Date and time of balance, transactions with a timestamp of ts are not included.
	dest	List to populate.

The function reads all transactions of the associate from the sales ledger with a transaction date before ts. An amount that is 0 and that has no currency, is ignored.

long OSB_DB::AccountArGw::fetchDuedays	(	const Session &	session,
		const OSB_LIB::Associate &	associate
	)

Load the due days.

This function will load the due days from AR based on a specific associate.

Parameters:

	session	Session
	associate	Associate

Returns:

Due days

Exceptions:

OsbException

in case of can not get the due days from AR database error.

long OSB_DB::AccountArGw::fetchTransactions	(	OSB_LIB::TransactionList &	transactions,
		const Session &	session,
		const OSB_LIB::Associate &	associate,
		const OSB_LIB::DateTime &	start,
		const OSB_LIB::DateTime &	end
	)

Load the payment transactions.

This function will load the payment transactions from AR to the transaction list for a given associate and the period of time.

Parameters:

	transactions	TransactionList to be populated
	session	Session
	associate	Associate
	start	Last bill date and time
	end	This bill date and time

Returns:

The number of transactions populated.

Exceptions:

OsbException

in case of database error.

AccountArGw& OSB_DB::AccountArGw::operator=

(

const AccountArGw &

rhs

)

[private]

Prevent assignment: Assignment not implemented.

bool OSB_DB::AccountArGw::updateInvoice	(	const Session &	session,
		const OSB_LIB::Associate &	associate,
		const OSB_LIB::Contract &	contract,
		const OSB_LIB::InvoiceInfo &	invInfo
	)

Update the invoice transaction for AR.

Parameters:

	session	Session
	associate	Associate
	contract	Contract
	invInfo	Invoice information

Returns:

True if success, else false.

Exceptions:

OsbException

in case of database error.

---

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

• accountar-gw.h

---