OSB_DB::RateCodeGw Class Reference

List of all members.

---

Detailed Description

Database interface for OSB_LIB::RateCode.

All members of the class private, only OSB_LIB::RateCodes should use this gateway.

Definition at line 61 of file tariff-gw.h.

Private Member Functions

• void read (const Session &session, OSB_LIB::RateCodes::Cont &dest)

  Read all rate codes from the database.
  

• void insert (const Session &session, OSB_LIB::RateCode *rc)

  Create a rate code in the database.
  

• void update (const Session &session, OSB_LIB::RateCode *rc)

  Update a rate code in the database.
  

• void remove (const Session &session, OSB_LIB::RateCode *rc)

  Delete a rate code from the database.
  

• void lock (const Session &session, OSB_LIB::RateCode *rc)

  Lock the rate code in the database.
  

• void checkUniqueness (const Session &session, const OSB_LIB::RateCode &rc)

  Check uniqueness of name and mnemonic.
  

Friends

• class OSB_LIB::RateCodes

  Only allow the rate code list to use this class.
  

---

Member Function Documentation

void OSB_DB::RateCodeGw::checkUniqueness	(	const Session &	session,
		const OSB_LIB::RateCode &	rc
	)			[private]

Check uniqueness of name and mnemonic.

Parameters:

	session	Database session to use.
	rc	Rating code for which to check.

Exceptions:

OsbException

if a know unique constraint is violated.

void OSB_DB::RateCodeGw::insert	(	const Session &	session,
		OSB_LIB::RateCode *	rc
	)			[private]

Create a rate code in the database.

Parameters:

	session	Database session to use.
	rc	Rating code to create, if the function returns successful, its object id and version are set.

Exceptions:

OsbException

if the name of the rate code is duplicate.

void OSB_DB::RateCodeGw::lock	(	const Session &	session,
		OSB_LIB::RateCode *	rc
	)			[private]

Lock the rate code in the database.

Parameters:

	session	Database session to use.
	rc	Rating code to lock, if the function returns normally, its object version is increased.

Exceptions:

	ObjectModified	if the object version does not match the database.
	ObjectDeleted	if the rate code does not (or never existed) in the database.

The function always throws if the rate code can not be locked.

void OSB_DB::RateCodeGw::read	(	const Session &	session,
		OSB_LIB::RateCodes::Cont &	dest
	)			[private]

Read all rate codes from the database.

Parameters:

	session	Database session to use.
	dest	STL container to populate. The caller is responsible to clear the container (or to take other suitable measures) before calling the function.

void OSB_DB::RateCodeGw::remove	(	const Session &	session,
		OSB_LIB::RateCode *	rc
	)			[private]

Delete a rate code from the database.

Parameters:

	session	Database session to use.
	rc	Rating code to delete, if the function returns successful, its object id is cleared.

Exceptions:

	ObjectModified	if the object version does not match the database.
	ObjectDeleted	if the rate code does not (or never existed) in the database.

void OSB_DB::RateCodeGw::update	(	const Session &	session,
		OSB_LIB::RateCode *	rc
	)			[private]

Update a rate code in the database.

Parameters:

	session	Database session to use.
	rc	Rating code to create, if the function returns successful, its object version is increased.

Exceptions:

	OsbException	if the name of the rate code is duplicate.
	ObjectModified	if the object version does not match the database.
	ObjectDeleted	if the rate code does not (or never existed) in the database.

---

Friends And Related Function Documentation

friend class OSB_LIB::RateCodes [friend]

Only allow the rate code list to use this class.

Definition at line 63 of file tariff-gw.h.

---

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

• tariff-gw.h

---