OSB_DB::ScSystemGw Struct Reference

List of all members.

---

Detailed Description

Database interface for ScSystem.

Definition at line 185 of file serviceclass-gw.h.

Public Member Functions

• bool fetch (const Session &session, OSB_LIB::ScSystem &scs)

  Populate a service class system object with data.
  

• long fetch (const Session &session, OSB_LIB::ScSystems &scss)

  Get a list of all available service class systems.
  

Private Member Functions

• bool insScSystem (const Session &session, OSB_LIB::ScSystem &scs)

  Add a new service class system.
  

• bool delScSystem (const Session &session, OSB_LIB::ScSystem &scs)

  Delete a service class system.
  

• bool updScSystem (const Session &session, OSB_LIB::ScSystem &scs)

  Update a service class system.
  

• OSB_LIB::ObjectStatus checkObjVs (const Session &session, const OSB_LIB::ScSystem &scs)

  Check the current object version.
  

Friends

• class OSB_LIB::ScSystem

---

Member Function Documentation

OSB_LIB::ObjectStatus OSB_DB::ScSystemGw::checkObjVs	(	const Session &	session,
		const OSB_LIB::ScSystem &	scs
	)			[private]

Check the current object version.

Parameters:

	session	Database session to use.
	scs	Service class system for which to check the object version.

Returns:

Result of the object version verification. Possible values are:

• objUnchanged
• objModified
• objDeleted

bool OSB_DB::ScSystemGw::delScSystem	(	const Session &	session,
		OSB_LIB::ScSystem &	scs
	)			[private]

Delete a service class system.

The service class system to be deleted must already exist in the database table. The object is not deleted automaticaly. Application will have to delete the object itself. After the function call, the object's id will be unset.

Parameters:

	session	Database session to use.
	scs	Service class system to delete.

Returns:

true if deletion is successful else false.

Exceptions:

OsbException

for the following errors: Object not found. Object has been modified. Refered by service class system version. Refered by tariff system version.

long OSB_DB::ScSystemGw::fetch	(	const Session &	session,
		OSB_LIB::ScSystems &	scss
	)

Get a list of all available service class systems.

This function retrieve all the available service class systems from the database.

Parameters:

	session	Database session to use.
	scss	STL container store the service class systems.

Returns:

Number of service class system available.

bool OSB_DB::ScSystemGw::fetch	(	const Session &	session,
		OSB_LIB::ScSystem &	scs
	)

Populate a service class system object with data.

This function accept an empty service class system with only its oid set. It will populate all other attribute of the object.

Parameters:

	session	Database session to use.
	scs	Service class system to populate.

Returns:

true if the object is found, else false.

bool OSB_DB::ScSystemGw::insScSystem	(	const Session &	session,
		OSB_LIB::ScSystem &	scs
	)			[private]

Add a new service class system.

Before the function call, the object must have all its member attributes assigned (except oid). After the function call, the object will get its oid_. In case of an error, exception is thrown.

Parameters:

	session	Database session to use.
	scs	Service class system to add.

Returns:

true if creation is successful else false.

Exceptions:

OsbException

for the following errors: Duplicate name.

bool OSB_DB::ScSystemGw::updScSystem	(	const Session &	session,
		OSB_LIB::ScSystem &	scs
	)			[private]

Update a service class system.

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

Parameters:

	session	Database session to use.
	scs	Service class system to update.

Returns:

true if updated successfully else false.

Exceptions:

OsbException

for the following errors: Object not found. Object has been modified. Duplicate name.

---

Friends And Related Function Documentation

friend class OSB_LIB::ScSystem [friend]

Service class system needs to call the private member functions.

Definition at line 190 of file serviceclass-gw.h.

---

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

• serviceclass-gw.h

---