OSB_DB::TpSystemGw Struct Reference

List of all members.

---

Detailed Description

Database interface TpSystem.

Definition at line 567 of file tariffperiod-gw.h.

Public Member Functions

• long fetch (const Session &session, OSB_LIB::TpSystems &tpss)

  Retrieve all tariff period systems.
  

• bool fetch (const Session &session, OSB_LIB::TpSystem &tps)

  Read a tariff period system from database based on oid.
  

Private Member Functions

• bool insTpSystem (const Session &session, OSB_LIB::TpSystem &tps)

  Create a new tariff period system.
  

• bool updTpSystem (const Session &session, OSB_LIB::TpSystem &tps)

  Update a tariff period system.
  

• bool delTpSystem (const Session &session, OSB_LIB::TpSystem &tps)

  Delete a tariff period system.
  

• OSB_LIB::ObjectStatus checkObjVs (const Session &session, const OSB_LIB::TpSystem &tps)

  Check the current object version.
  

Friends

• class OSB_LIB::TpSystem

  TP system needs to call the private member functions.
  

---

Member Function Documentation

OSB_LIB::ObjectStatus OSB_DB::TpSystemGw::checkObjVs	(	const Session &	session,
		const OSB_LIB::TpSystem &	tps
	)			[private]

Check the current object version.

Parameters:

	session	Database session.
	tps	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::TpSystemGw::delTpSystem	(	const Session &	session,
		OSB_LIB::TpSystem &	tps
	)			[private]

Delete a tariff period system.

This function will delete the tariff period system from the database base on the pass in object. After a successful function call, the passed in tariff period system object will have its object id unset.

Parameters:

	session	Database session.
	tps	Tariff period system to be deleted.

Returns:

true if success else false.

Exceptions:

OsbException

for the following errors: Object not found. Object has been modified. Other database errors.

bool OSB_DB::TpSystemGw::fetch	(	const Session &	session,
		OSB_LIB::TpSystem &	tps
	)

Read a tariff period system from database based on oid.

Parameters:

	session	Database session.
	tps	Tariff period system to be populated.

Returns:

true if success else false.

Exceptions:

OsbException

any database errors.

long OSB_DB::TpSystemGw::fetch	(	const Session &	session,
		OSB_LIB::TpSystems &	tpss
	)

Retrieve all tariff period systems.

Parameters:

	session	Database session.
	tpss	Container to store all the tariff period system retrieved.

Returns:

Number of tariff period system retrieved.

Exceptions:

OsbException

any database errors.

bool OSB_DB::TpSystemGw::insTpSystem	(	const Session &	session,
		OSB_LIB::TpSystem &	tps
	)			[private]

Create a new tariff period system.

This function will create a new entry in the database base on the input object. After a successful function call, the new object will have its object id set.

Parameters:

	session	Database session.
	tps	New tariff period system object.

Returns:

true if success else false.

Exceptions:

OsbException

for the following errors: Name too long. Description too long. Duplicate name. Other database error.

bool OSB_DB::TpSystemGw::updTpSystem	(	const Session &	session,
		OSB_LIB::TpSystem &	tps
	)			[private]

Update a tariff period system.

This function will update a tariff period system entry in database based on the updated object passed in.

Parameters:

	session	Database session.
	tps	Updated tariff period system.

Returns:

true if success else false.

Exceptions:

OsbException

for the following errors: Name too long. Duplicate name. Object not found. Object has been modified. Other database error.

---

Friends And Related Function Documentation

friend class OSB_LIB::TpSystem [friend]

TP system needs to call the private member functions.

Definition at line 569 of file tariffperiod-gw.h.

---

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

• tariffperiod-gw.h

---