OSB_DB::DeviceGw Struct Reference

List of all members.

---

Detailed Description

Database gateway to DEVICE.

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

Public Member Functions

• bool fetch (const Session &session, OSB_LIB::Device &device)

  Read a device.
  

• void insert (const Session &session, OSB_LIB::Device &device)

  Create a device.
  

• bool updData (const Session &session, const OSB_LIB::Device &device)

  Update the data of a device.
  

• bool updStatus (const Session &session, const OSB_LIB::Device &device)

  Update the status of a device.
  

• bool remove (const Session &session, const OSB_LIB::Device &device)

  Delete a device.
  

Locking and object version maintenance:

• OSB_LIB::ObjectStatus lock (const Session &session, const OSB_LIB::Id< OSB_LIB::Device > &devId, bool noWait)

  Lock a device in database.
  

• OSB_LIB::ObjectStatus lock (const Session &session, const OSB_LIB::Device &device, bool noWait)

  Lock a contract in the database.
  

• bool incObjVs (const Session &session, OSB_LIB::Device &device)

  Increment the object version of a device.
  

---

Member Function Documentation

bool OSB_DB::DeviceGw::fetch	(	const Session &	session,
		OSB_LIB::Device &	device
	)

Read a device.

Parameters:

	session	Database session to use.
	device	Device to read, its object id and type are used as selection criteria.

Returns:

true if the device was found and read, else false.

bool OSB_DB::DeviceGw::incObjVs	(	const Session &	session,
		OSB_LIB::Device &	device
	)

Increment the object version of a device.

Parameters:

	session	Database session to use.
	device	The device who's object version is increased.

Returns:

true if the object version of device was increased by 1, else false.

void OSB_DB::DeviceGw::insert	(	const Session &	session,
		OSB_LIB::Device &	device
	)

Create a device.

Parameters:

	session	Database session to use.
	device	Device to create.

OSB_LIB::ObjectStatus OSB_DB::DeviceGw::lock	(	const Session &	session,
		const OSB_LIB::Device &	device,
		bool	noWait
	)

Lock a contract in the database.

Parameters:

	session	Database session to use.
	device	The device to lock.
	noWait	Don't wait if locked by another session?

Returns:

The object status of the device.

OSB_LIB::ObjectStatus OSB_DB::DeviceGw::lock	(	const Session &	session,
		const OSB_LIB::Id< OSB_LIB::Device > &	devId,
		bool	noWait
	)

Lock a device in database.

Parameters:

	session	Database session to use.
	devId	Id of the device to lock.
	noWait	Don't wait if locked by another session?

Returns:

The object status of the device (modified is not applicable).

bool OSB_DB::DeviceGw::remove	(	const Session &	session,
		const OSB_LIB::Device &	device
	)

Delete a device.

Parameters:

	session	Database session to use.
	device	Device to delete.

Returns:

true if the device was deleted, else false.

Exceptions:

OsbException

if child records exist.

bool OSB_DB::DeviceGw::updData	(	const Session &	session,
		const OSB_LIB::Device &	device
	)

Update the data of a device.

Parameters:

	session	Database session to use.
	device	Device to update.

Returns:

true if the device was updated, else false.

bool OSB_DB::DeviceGw::updStatus	(	const Session &	session,
		const OSB_LIB::Device &	device
	)

Update the status of a device.

Parameters:

	session	Database session to use.
	device	Device to update.

Returns:

true if the device was updated, else false.

---

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

• device-gw.h

---