OSB_DB::RfStairCaseGw Struct Reference

List of all members.

---

Detailed Description

Database interface for RfStairCase.

Definition at line 249 of file ratingfn-gw.h.

Public Member Functions

• bool fetch (const Session &session, OSB_LIB::RfStairCase &rf)

  Populate a stair case rating function object with data.
  

Private Member Functions

• bool insRfStairCase (const Session &session, OSB_LIB::RfStairCase &rf)

  Add a new stair case rating function.
  

• bool delRfStairCase (const Session &session, OSB_LIB::RfStairCase &rf)

  Delete a stair case rating function.
  

• bool updRfStairCase (const Session &session, OSB_LIB::RfStairCase &rf)

  Update a stair case rating function.
  

Friends

• class OSB_LIB::RfStairCase

---

Member Function Documentation

bool OSB_DB::RfStairCaseGw::delRfStairCase	(	const Session &	session,
		OSB_LIB::RfStairCase &	rf
	)			[private]

Delete a stair case rating function.

The rating function to be deleted must already exist in the database. After the function call, the object's id will not be unset. The base class delete function will unset the oid if completed successfully.

Parameters:

	session	Database session.
	rf	Rating function to be deleted.

Returns:

true if deletion is successful else false.

Exceptions:

OsbException

for the following errors: Database error.

bool OSB_DB::RfStairCaseGw::fetch	(	const Session &	session,
		OSB_LIB::RfStairCase &	rf
	)

Populate a stair case rating function object with data.

This function accept an empty stair case rating function with only its oid set. It will populate all other attributes of the object.

Parameters:

	session	Database session.
	rf	Stair case rating function to be populated.

Returns:

true if the object is found, else false.

Exceptions:

OsbException

for the following errors: Database error.

bool OSB_DB::RfStairCaseGw::insRfStairCase	(	const Session &	session,
		OSB_LIB::RfStairCase &	rf
	)			[private]

Add a new stair case rating function.

Before the function call, the object must have all its member attributes assigned (except oid and object version). The object will get its oid_ and objVs_ after the base class insert function completed successfully. In case of an error, exception is thrown.

Parameters:

	session	Database session.
	rf	New stair case rating function to be added.

Returns:

true if creation is successful else false.

Exceptions:

OsbException

for the following errors: Database error.

bool OSB_DB::RfStairCaseGw::updRfStairCase	(	const Session &	session,
		OSB_LIB::RfStairCase &	rf
	)			[private]

Update a stair case rating function.

The function will modify the data of an object in the database with the data contained within the input rating function object.

Parameters:

	session	Database session.
	rf	Stair case rating function to be updated, which contains the new set of data within.

Returns:

true if updated successfully else false.

Exceptions:

OsbException

for the following errors: Database error.

---

Friends And Related Function Documentation

friend class OSB_LIB::RfStairCase [friend]

Rating function needs to call the private member functions.

Definition at line 253 of file ratingfn-gw.h.

---

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

• ratingfn-gw.h

---