OSB_DB::NumberAnalyzerGw Class Reference

List of all members.

---

Detailed Description

Database gateway for the class NumberAnalyzer.

This is the gateway for the class NumberAnalyzer for performing all the database operations.

Definition at line 57 of file numberanalyzer-gw.h.

Public Member Functions

• long fetch (const Session &session, OSB_LIB::NumberAnalyzerList &numberAnalyzers) const

  Retrieve all number analyzer from database.
  

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

  Populate the passed in number analyzer object.
  

Private Member Functions

• void insNumberAnalyzer (const Session &session, OSB_LIB::NumberAnalyzer &numberAnalyzer) const

  Insert the number analyzer object into database.
  

• void delNumberAnalyzer (const Session &session, OSB_LIB::NumberAnalyzer &numberAnalyzer) const

  Remove a number analyzer object from database.
  

• void updNumberAnalyzer (const Session &session, OSB_LIB::NumberAnalyzer &numberAnalyzer) const

  Update the information of a number analyzer in database.
  

Friends

• class OSB_LIB::NumberAnalyzer

  Only number analyzer is allowed to invoke private functions.
  

---

Member Function Documentation

void OSB_DB::NumberAnalyzerGw::delNumberAnalyzer	(	const Session &	session,
		OSB_LIB::NumberAnalyzer &	numberAnalyzer
	)			const [private]

Remove a number analyzer object 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 version differs, an OsbException will be thrown. If the object does not exist in database, nothing will be performed (no error or exception will be raised).

On successful deletion, the object id of the passed in number analyzer object will be unset.

Parameters:

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

bool OSB_DB::NumberAnalyzerGw::fetch	(	const Session &	session,
		OSB_LIB::NumberAnalyzer &	numberAnalyzer
	)			const

Populate the passed in number analyzer object.

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 data members overwritten with the data in database.

Parameters:

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

Returns:

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

long OSB_DB::NumberAnalyzerGw::fetch	(	const Session &	session,
		OSB_LIB::NumberAnalyzerList &	numberAnalyzers
	)			const

Retrieve all number analyzer from database.

This function retrieves all information regarding number analyzer objects from database. It then create a list of number analyzer objects and put them in the STL container passed in.

Parameters:

	session	Database session used.
	numberAnalyzers	STL container for the list of number analyzer created.

void OSB_DB::NumberAnalyzerGw::insNumberAnalyzer	(	const Session &	session,
		OSB_LIB::NumberAnalyzer &	numberAnalyzer
	)			const [private]

Insert the number analyzer object into database.

This function will use the data contained within the number analyzer object to create a new entry in database. Upon successful insertion, an unique object id will be created. The function will populate the object passed in with the unique object id it received from database.

Parameters:

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

Exceptions:

OsbException

if the newly created number analyzer is assigned to a trunk group that already owns a number analyzer.

void OSB_DB::NumberAnalyzerGw::updNumberAnalyzer	(	const Session &	session,
		OSB_LIB::NumberAnalyzer &	numberAnalyzer
	)			const [private]

Update the information of a number analyzer 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. The object version differs.

---

Friends And Related Function Documentation

friend class OSB_LIB::NumberAnalyzer [friend]

Only number analyzer is allowed to invoke private functions.

Definition at line 59 of file numberanalyzer-gw.h.

---

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

• numberanalyzer-gw.h

---