OSB_DB::BillcycleGw Class Reference

List of all members.

---

Detailed Description

BillcycleGw, database-gateway for Billcycle.

BillcycleGw is the database gateway class for Billcycle. This is a purely static class, i.e., it cannot be instantiated.

Definition at line 65 of file billcycle-gw.h.

Static Public Member Functions

• static long fetch (const Session &session, OSB_LIB::BillcycleList &bcList)

  Load all billcycles.
  

• static bool fetchIntervalBillcycle (const Session &session, OSB_LIB::IntervalBillcycle *bc)

  Load IntervalBillcycle specific parameters.
  

• static bool fetchMidMonthBillcycle (const Session &session, OSB_LIB::MidMonthBillcycle *bc)

  Load MidMonthBillcycle specific parameters.
  

Private Member Functions

• BillcycleGw ()

  Prevent construction: not implemented.
  

---

Constructor & Destructor Documentation

OSB_DB::BillcycleGw::BillcycleGw

(

)

[private]

Prevent construction: not implemented.

---

Member Function Documentation

static long OSB_DB::BillcycleGw::fetch	(	const Session &	session,
		OSB_LIB::BillcycleList &	bcList
	)			[static]

Load all billcycles.

Parameters:

	session	Database session to use.
	bcList	List of billcycle.

Exceptions:

OsbException

invalid billcycle type

Returns:

Number of objects populated.

static bool OSB_DB::BillcycleGw::fetchIntervalBillcycle	(	const Session &	session,
		OSB_LIB::IntervalBillcycle *	bc
	)			[static]

Load IntervalBillcycle specific parameters.

Parameters:

	session	Database session to use.
	bc	Billcycle to output to.

Exceptions:

OsbException

invalid billcycle data

Returns:

true in case of success, false if the billcycle does not exist in the database.

static bool OSB_DB::BillcycleGw::fetchMidMonthBillcycle	(	const Session &	session,
		OSB_LIB::MidMonthBillcycle *	bc
	)			[static]

Load MidMonthBillcycle specific parameters.

Parameters:

	session	Database session to use.
	bc	Billcycle to output to.

Exceptions:

OsbException

invalid billcycle data

Returns:

true in case of success, false if the billcycle does not exist in the database.

---

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

• billcycle-gw.h

---