OSB_DB::TrunkGroupGw Class Reference

List of all members.

---

Detailed Description

Database-gateway class for TrunkGroup.

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

Public Member Functions

• TrunkGroupGw ()

  Default constructor.
  

• bool fetch (const Session &session, OSB_LIB::TrunkGroup &trkGroup)

  Read a trunk group from the database.
  

• long fetch (const Session &session, const OSB_LIB::NetworkElement::Oid &elementId, OSB_LIB::TrunkGroups &trkGroups)

  Read trunk groups of a network element.
  

Private Member Functions

• TrunkGroupGw (const TrunkGroupGw &rhs)

  Prevent copying: Copy constructor not implemented.
  

• TrunkGroupGw & operator= (const TrunkGroupGw &rhs)

  Prevent assignment: Assignment not implemented.
  

• bool insert (const Session &session, OSB_LIB::TrunkGroup &trkGroup)

  Insert a trunk group to the database.
  

• bool update (const Session &session, OSB_LIB::TrunkGroup &trkGroup)

  Update a trunk group to the database.
  

• bool remove (const Session &session, OSB_LIB::TrunkGroup &trkGroup)

  Delete a trunk group from the database.
  

• std::auto_ptr< OSB_LIB::NumberAnalyzer > getRelatedNumAnalyzer (const Session &session, OSB_LIB::TrunkGroup &trkGroup)

  Get the number analyzer assigned to a trunk group.
  

• OSB_LIB::ObjectStatus checkObjVs (const Session &session, const OSB_LIB::TrunkGroup &trkGroup)

  Check the current object version of trunk group.
  

Friends

• class OSB_LIB::TrunkGroup

  Allow accessing insert, update and delete.
  

---

Constructor & Destructor Documentation

OSB_DB::TrunkGroupGw::TrunkGroupGw

(

const TrunkGroupGw &

rhs

)

[private]

Prevent copying: Copy constructor not implemented.

OSB_DB::TrunkGroupGw::TrunkGroupGw

(

)

[inline]

Default constructor.

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

---

Member Function Documentation

OSB_LIB::ObjectStatus OSB_DB::TrunkGroupGw::checkObjVs	(	const Session &	session,
		const OSB_LIB::TrunkGroup &	trkGroup
	)			[private]

Check the current object version of trunk group.

Parameters:

	session	Database session to use.
	trkGroup	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::TrunkGroupGw::fetch	(	const Session &	session,
		const OSB_LIB::NetworkElement::Oid &	elementId,
		OSB_LIB::TrunkGroups &	trkGroups
	)

Read trunk groups of a network element.

Parameters:

	session	Database session to use.
	elementId	Network element to read for.
	trkGroups	STL container to store the trunk groups.

Returns:

Number of objects populated.

bool OSB_DB::TrunkGroupGw::fetch	(	const Session &	session,
		OSB_LIB::TrunkGroup &	trkGroup
	)

Read a trunk group from the database.

The function (re)reads an existing trunk group from the database. It populates data members if a matching row is found.

Parameters:

	session	Database session to use.
	trkGroup	Trunk group to read for.

Returns:

True if the trunk group was read from the database, else false. In the latter case the `trkGroup' remains unchanged.

std::auto_ptr<OSB_LIB::NumberAnalyzer> OSB_DB::TrunkGroupGw::getRelatedNumAnalyzer	(	const Session &	session,
		OSB_LIB::TrunkGroup &	trkGroup
	)			[private]

Get the number analyzer assigned to a trunk group.

This function will search through the database table and get the number analyzer assigned to the passed in trunk group object.

Parameters:

	session	Database session to use.
	trkGroup	Trunk group where all assigned number analyzer will be deleted.

Returns:

An auto pointer that owns the number analyzer retrieved or 0.

bool OSB_DB::TrunkGroupGw::insert	(	const Session &	session,
		OSB_LIB::TrunkGroup &	trkGroup
	)			[private]

Insert a trunk group to the database.

Before the function call, the trunk group 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.
	trkGroup	Ref to trunk group to be inserted.

Exceptions:

OsbException

invalid argument length.

Returns:

True if the trunk group was inserted into the database.

TrunkGroupGw& OSB_DB::TrunkGroupGw::operator=

(

const TrunkGroupGw &

rhs

)

[private]

Prevent assignment: Assignment not implemented.

bool OSB_DB::TrunkGroupGw::remove	(	const Session &	session,
		OSB_LIB::TrunkGroup &	trkGroup
	)			[private]

Delete a trunk group from the database.

Object id of the trunk group passed in will be unset.

Parameters:

	session	Database session to use.
	trkGroup	Trunk group to be deleted.

Exceptions:

OsbException

object version conflict.

Returns:

True if the trunk group was deleted from the database.

bool OSB_DB::TrunkGroupGw::update	(	const Session &	session,
		OSB_LIB::TrunkGroup &	trkGroup
	)			[private]

Update a trunk group to the database.

ObjVs will be set after the successful update.

Parameters:

	session	Database session to use.
	trkGroup	Ref to trunk group to be updated.

Exceptions:

OsbException

invalid argument length object version conflict.

Returns:

True if the trunk group was updated into the database.

---

Friends And Related Function Documentation

friend class OSB_LIB::TrunkGroup [friend]

Allow accessing insert, update and delete.

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

---

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

• network-gw.h

---