OSB_DB::NumberAnalyzer01Gw Class Reference

List of all members.

---

Detailed Description

Database gateway for the class NumberAnalyzer01.

This is the gateway for the class NumberAnalyzer01 for performing all the derieved class specific database operations.

Definition at line 58 of file numberanalyzer01-gw.h.

Private Member Functions

• bool fetch (const Session &session, OSB_LIB::NumberAnalyzer01 &numberAnalyzer) const

  Populate the passed in number analyzer 01 with the derieved class data.
  

• void insNumberAnalyzer01 (const Session &session, OSB_LIB::NumberAnalyzer01 &numberAnalyzer) const

  Insert the number analyzer derieved class data into database.
  

• void delNumberAnalyzer01 (const Session &session, OSB_LIB::NumberAnalyzer01 &numberAnalyzer) const

  Remove a number analyzer derieved class specific data from database.
  

• void updNumberAnalyzer01 (const Session &session, OSB_LIB::NumberAnalyzer01 &numberAnalyzer) const

  Update the derieved class specific information of number analyzer 01 in database.
  

Friends

• class OSB_LIB::NumberAnalyzer01

  Only number analyzer 01 is allowed to invoke this class.
  

---

Member Function Documentation

void OSB_DB::NumberAnalyzer01Gw::delNumberAnalyzer01	(	const Session &	session,
		OSB_LIB::NumberAnalyzer01 &	numberAnalyzer
	)			const [private]

Remove a number analyzer derieved class specific data from database.

This function takes the object id and object version from the number analyzer object passed in to remove the corresponding entry from database.

If the object does not exist in database, nothing will be performed (no error or exception will be raised).

Parameters:

	session	Database session used.
	numberAnalyzer	Number analyzer object to be deleted.

bool OSB_DB::NumberAnalyzer01Gw::fetch	(	const Session &	session,
		OSB_LIB::NumberAnalyzer01 &	numberAnalyzer
	)			const [private]

Populate the passed in number analyzer 01 with the derieved class data.

The passed in number analyzer object must have its object id set. The database entry retrieved will based on the object id. Upon successful completion of the function, the passed in object will have all its derieved class data members overwritten with the data in database.

Derieved class data members must exist whenever a number analyzer object is created. If not, it is an error.

Parameters:

	session	Database session used.
	numberAnalyzer	NumberAnalyzer01 object to be populated.

Returns:

true if the function completed successfully. It return false if the object id cannot be found in database.

void OSB_DB::NumberAnalyzer01Gw::insNumberAnalyzer01	(	const Session &	session,
		OSB_LIB::NumberAnalyzer01 &	numberAnalyzer
	)			const [private]

Insert the number analyzer derieved class data into database.

This function will use the data contained within the number analyzer object to create a new entry in database.

Parameters:

	session	Database session used.
	numberAnalyzer	Newly created number analyzer object that is to be inserted into database.

void OSB_DB::NumberAnalyzer01Gw::updNumberAnalyzer01	(	const Session &	session,
		OSB_LIB::NumberAnalyzer01 &	numberAnalyzer
	)			const [private]

Update the derieved class specific information of number analyzer 01 in database.

This function will take the data from the passed in object and overwrite the corresponding entry in database based on the object id.

Parameters:

	session	Database session used.
	numberAnalyzer	Number analyzer object that carries the new data to be updated into database.

Exceptions:

OsbException

if: The corresponding entry cannot be found in database.

---

Friends And Related Function Documentation

friend class OSB_LIB::NumberAnalyzer01 [friend]

Only number analyzer 01 is allowed to invoke this class.

Definition at line 60 of file numberanalyzer01-gw.h.

---

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

• numberanalyzer01-gw.h

---