OSB_DB::TcSystemGw Struct Reference

List of all members.

---

Detailed Description

Database interface for TcSystem.

Definition at line 181 of file tariffclass-gw.h.

Public Member Functions

• long fetch (const Session &session, OSB_LIB::TcSystems &tcses)

  Load all tariff classification systems into the argument STL container.
  

• bool fetch (const Session &session, OSB_LIB::TcSystem &tcs)

  Populate a tariff classification system object.
  

• bool insTcSystem (const Session &session, OSB_LIB::TcSystem &tcs)

  Create a record in the database.
  

• bool delTcSystem (const Session &session, OSB_LIB::TcSystem &tcs)

  Delete a tariff classification system from database.
  

• bool updTcSystem (const Session &session, OSB_LIB::TcSystem &tcs)

  Modify tariff classification system.
  

• OSB_LIB::ObjectStatus checkObjVs (const Session &session, const OSB_LIB::TcSystem &tcs)

  Check the current object version.
  

Friends

• class OSB_LIB::TcSystem

---

Member Function Documentation

OSB_LIB::ObjectStatus OSB_DB::TcSystemGw::checkObjVs	(	const Session &	session,
		const OSB_LIB::TcSystem &	tcs
	)

Check the current object version.

Parameters:

	session	Database session.
	tcs	Object where the object version is to be checked.

Returns:

Result of the object version verification. Possible values are:

• objUnchanged
• objModified
• objDeleted

Exceptions:

OsbException

for the following errors: Database error.

bool OSB_DB::TcSystemGw::delTcSystem	(	const Session &	session,
		OSB_LIB::TcSystem &	tcs
	)

Delete a tariff classification system from database.

This function removes the tariff classification system from the database base on the object id of the passed in tariff classification system object. On successful deletion, the object id of the passed in tariff classification system object will be unset.

Parameters:

	session	Database session.
	tcs	Tariff classification system to be deleted.

Returns:

true if success else false.

Exceptions:

OsbException

if encounter problem during process.

bool OSB_DB::TcSystemGw::fetch	(	const Session &	session,
		OSB_LIB::TcSystem &	tcs
	)

Populate a tariff classification system object.

This function will retrieve the data from database, based on the object id of the passed in tariff classification system object. Then the data retrieved will be used to populater the passed in object.

Parameters:

	session	Database session.
	tcs	Tariff classification system to be populated.

Returns:

true if success else false;

Exceptions:

OsbException

for any database errors.

long OSB_DB::TcSystemGw::fetch	(	const Session &	session,
		OSB_LIB::TcSystems &	tcses
	)

Load all tariff classification systems into the argument STL container.

Parameters:

	session	Database session.
	tcses	Container for the tariff classification system retrieved.

Returns:

Number of objects retrieved.

Exceptions:

OsbException

when encounter problem during process.

bool OSB_DB::TcSystemGw::insTcSystem	(	const Session &	session,
		OSB_LIB::TcSystem &	tcs
	)

Create a record in the database.

Insert a new tariff classification system entry into the database. The passed in object will have its object id set if the insertion is successful.

Parameters:

	session	Database session.
	tcs	New tariff classification system object.

Returns:

true if success else false.

Exceptions:

OsbException

if name and description is longer than the number of characters allowed and if encounter problem during process.

bool OSB_DB::TcSystemGw::updTcSystem	(	const Session &	session,
		OSB_LIB::TcSystem &	tcs
	)

Modify tariff classification system.

Update the database entry with the data from the updated tariff classification system object passed in. This function will update te database entry based on the object id of the passed in object.

Parameters:

	session	Database session.
	tcs	Updated tariff classification system.

Returns:

true if success else false.

Exceptions:

OsbException

if name and description is longer than the number of characters allowed and if encounter problem during process.

---

Friends And Related Function Documentation

friend class OSB_LIB::TcSystem [friend]

Tariff classification system needs to call the private member functions.

Definition at line 186 of file tariffclass-gw.h.

---

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

• tariffclass-gw.h

---