OSB_DB::TrunkResourceGw Class Reference

List of all members.

---

Detailed Description

Interface to table TRUNK_RESOURCE.

Definition at line 66 of file trunkresource-gw.h.

Public Member Functions

• void fetch (const Session &session, TrList &dest, const NwOid &nwId, bool availOnly)

  Read trunk resources from database.
  

Private Types

• typedef OSB_LIB::ResourceList<
  OSB_LIB::TrunkResource > TrList

  Short-cut for a list of trunk resources.
  

• typedef OSB_LIB::Id< OSB_LIB::Network > NwOid

  Short-cut for a network id.
  

Private Member Functions

• bool read (const Session &session, OSB_LIB::TrunkResource &tr) const

  Read a trunk resource by its id.
  

• bool insert (const Session &session, const OSB_LIB::TrunkResource &tr) const

  Insert a trunk resource into the database.
  

• bool update (const Session &session, const OSB_LIB::TrunkResource &tr) const

  Update a trunk resource in the database.
  

• bool remove (const Session &session, const OSB_LIB::TrunkResource &tr) const

  Delete trunk resource specific data.
  

• bool insTrkGroup (const Session &session, const OSB_LIB::TrunkResource::Oid &trId, const OSB_LIB::TrunkResource::AssignedTrunk &assignedTg) const

  Assign a trunk group to a trunk resource.
  

• bool updTrkGroup (const Session &session, const OSB_LIB::TrunkResource::Oid &trId, const OSB_LIB::Id< OSB_LIB::TrunkGroup > &tgId) const

  Deassign a trunk group from a trunk resource.
  

Friends

• class OSB_LIB::TrunkResource

  Allow trunk resource to calls its supporting functions.
  

---

Member Typedef Documentation

typedef OSB_LIB::Id<OSB_LIB::Network> OSB_DB::TrunkResourceGw::NwOid [private]

Short-cut for a network id.

Definition at line 73 of file trunkresource-gw.h.

typedef OSB_LIB::ResourceList<OSB_LIB::TrunkResource> OSB_DB::TrunkResourceGw::TrList [private]

Short-cut for a list of trunk resources.

Definition at line 71 of file trunkresource-gw.h.

---

Member Function Documentation

void OSB_DB::TrunkResourceGw::fetch	(	const Session &	session,
		TrList &	dest,
		const NwOid &	nwId,
		bool	availOnly
	)

Read trunk resources from database.

Parameters:

	session	Database session to use.
	dest	Trunk resource list to populate.
	nwId	Id of the network id for which to read the trunk resources.
	availOnly	Flag if only available trunk resources should be read.

Reads the id's of the matching trunk resources, creates a trunk resource object, lets this object read itself from the database and finally calls dest.replace that adds or replaces the trunk resource in the destination list.

bool OSB_DB::TrunkResourceGw::insert	(	const Session &	session,
		const OSB_LIB::TrunkResource &	tr
	)			const [private]

Insert a trunk resource into the database.

bool OSB_DB::TrunkResourceGw::insTrkGroup	(	const Session &	session,
		const OSB_LIB::TrunkResource::Oid &	trId,
		const OSB_LIB::TrunkResource::AssignedTrunk &	assignedTg
	)			const [private]

Assign a trunk group to a trunk resource.

Parameters:

	session	Database session to use.
	trId	Trunk resource id.
	assignedTg	Trunk group assignment to add.

Exceptions:

OsbException

if the trunk group is assigned to another trunk resource.

Returns:

True if the trunk group was successfully assigned to the resource, else false.

bool OSB_DB::TrunkResourceGw::read	(	const Session &	session,
		OSB_LIB::TrunkResource &	tr
	)			const [private]

Read a trunk resource by its id.

bool OSB_DB::TrunkResourceGw::remove	(	const Session &	session,
		const OSB_LIB::TrunkResource &	tr
	)			const [private]

Delete trunk resource specific data.

Parameters:

	session	Database session to use.
	tr	Trunk resource to delete.

Exceptions:

OsbException

if trunk group assignments to the resource exists (active or not).

Returns:

True if the trunk resource were deleted, else false.

bool OSB_DB::TrunkResourceGw::update	(	const Session &	session,
		const OSB_LIB::TrunkResource &	tr
	)			const [private]

Update a trunk resource in the database.

bool OSB_DB::TrunkResourceGw::updTrkGroup	(	const Session &	session,
		const OSB_LIB::TrunkResource::Oid &	trId,
		const OSB_LIB::Id< OSB_LIB::TrunkGroup > &	tgId
	)			const [private]

Deassign a trunk group from a trunk resource.

Parameters:

	session	Database session to use.
	trId	Trunk resource id.
	tgId	Trunk group id.

Exceptions:

OsbException

if the trunk group is currently not assigned to the resource.

Returns:

True if the trunk group was successfully deassigned from the trunk group, else false.

---

Friends And Related Function Documentation

friend class OSB_LIB::TrunkResource [friend]

Allow trunk resource to calls its supporting functions.

Definition at line 68 of file trunkresource-gw.h.

---

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

• trunkresource-gw.h

---