OSB_DB::NetworkGw Class Reference

List of all members.

---

Detailed Description

Database-gateway class for Network.

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

Public Member Functions

• bool fetch (const Session &session, OSB_LIB::Network &net)

  Read a network from the database.
  

• long fetch (const Session &session, OSB_LIB::Networks &netList)

  Read all networks.
  

Private Member Functions

• bool insert (const Session &session, OSB_LIB::Network &net)

  Insert a network to the database.
  

• bool update (const Session &session, OSB_LIB::Network &net)

  Update a network to the database.
  

• bool remove (const Session &session, OSB_LIB::Network &net)

  Delete a network from the database.
  

• OSB_LIB::ObjectStatus checkObjVs (const Session &session, const OSB_LIB::Network &net)

  Check the current object version of network.
  

Friends

• class OSB_LIB::Network

  Allow accessing insert, update and delete.
  

---

Member Function Documentation

OSB_LIB::ObjectStatus OSB_DB::NetworkGw::checkObjVs	(	const Session &	session,
		const OSB_LIB::Network &	net
	)			[private]

Check the current object version of network.

Parameters:

	session	Database session to use.
	net	object where the object version is to be checked.

Returns:

Result of the object version verification. Possible values are:

• objUnchanged
• objModified
• objDeleted

long OSB_DB::NetworkGw::fetch	(	const Session &	session,
		OSB_LIB::Networks &	netList
	)

Read all networks.

It will also retrieve network element list for every network.

Parameters:

	session	Database session to use.
	netList	List of networks.

Returns:

Number of objects populated.

bool OSB_DB::NetworkGw::fetch	(	const Session &	session,
		OSB_LIB::Network &	net
	)

Read a network from the database.

The function (re)reads an existing network from the database. It populates data members if a matching row is found. It will also retrieve network element list.

Parameters:

	session	Database session to use.
	net	Network to read.

Returns:

True if the network was read from the database, else false. In the latter case the `net' remains unchanged.

bool OSB_DB::NetworkGw::insert	(	const Session &	session,
		OSB_LIB::Network &	net
	)			[private]

Insert a network to the database.

Before the function call, the network object to be added must have all its data members set except oid and objvs. After the function completed successfully, oid and objVs will be set.

Parameters:

	session	Database session to use.
	net	Ref to network to be inserted.

Exceptions:

OsbException

invalid argument length.

Returns:

True if the network was inserted into the database.

bool OSB_DB::NetworkGw::remove	(	const Session &	session,
		OSB_LIB::Network &	net
	)			[private]

Delete a network from the database.

Object id of the network passed in will be unset.

Parameters:

	session	Database session to use.
	net	Network to be deleted.

Exceptions:

OsbException

object version conflict.

Returns:

True if the network was deleted from the database.

bool OSB_DB::NetworkGw::update	(	const Session &	session,
		OSB_LIB::Network &	net
	)			[private]

Update a network to the database.

ObjVs will be set after the successful update.

Parameters:

	session	Database session to use.
	net	Ref to network to be updated.

Exceptions:

OsbException

invalid argument length object version conflict.

Returns:

True if the network was updated into the database.

---

Friends And Related Function Documentation

friend class OSB_LIB::Network [friend]

Allow accessing insert, update and delete.

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

---

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

• network-gw.h

---