OSB_DB::CatLockGw Class Reference

List of all members.

---

Detailed Description

Database gateway to CATALOGUE_LOCK table.

Definition at line 55 of file catlock-gw.h.

Public Types

• lockProductCatalogue = 1

  Lock product catalogue.
  

• lockTariffCatalogue = 2

  Lock tariff catalogue.
  

• enum CatLock { lockProductCatalogue = 1, lockTariffCatalogue = 2 }

Public Member Functions

• CatLockGw ()

  Constructor.
  

• bool lock (const Session &session, const long lockId, bool noWait=true)

  Temporary locks for catalogues.
  

---

Member Enumeration Documentation

enum OSB_DB::CatLockGw::CatLock

Enumerator:

lockProductCatalogue	Lock product catalogue.
lockTariffCatalogue	Lock tariff catalogue.

Definition at line 61 of file catlock-gw.h.

---

Constructor & Destructor Documentation

OSB_DB::CatLockGw::CatLockGw

(

)

[inline]

Constructor.

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

---

Member Function Documentation

bool OSB_DB::CatLockGw::lock	(	const Session &	session,
		const long	lockId,
		bool	noWait = true
	)

Temporary locks for catalogues.

The functions tries to lock the row that is identified by lockId in the table CATALOGUE_LOCK. If the lock fails and wait flag is set to true, the function waits until the row becomes available. The function returns true if the requested row could be locked, else false. In case of a database error it throws OsbException.

Parameters:

	session	Database session.
	lockId	Unique lock id.
	noWait	This input will tell database whether it will wait to access this table until the previous lock function finishes.

Returns:

A bool varibale to indicate that whether this lock function is successfully.

Exceptions:

OsbException

In case of a database error.

---

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

• catlock-gw.h

---