OSB_DB::OsbUserGw Class Reference

List of all members.

---

Detailed Description

Database gateway class for OsbUser.

Definition at line 57 of file osbuser-gw.h.

Public Member Functions

• bool fetch (const Session &session, OSB_LIB::OsbUser &osbUser)

  Read a OSB user from the database.
  

• void fetch (const Session &session, OSB_LIB::Users &osbUsers)

  Read all OSB users from the database.
  

Private Member Functions

• void insert (const Session &session, OSB_LIB::OsbUser &osbUser)

  Insert a OSB user into the database.
  

• void update (const Session &session, OSB_LIB::OsbUser &osbUser)

  Update a OSB user in the database.
  

• void remove (const Session &session, OSB_LIB::OsbUser &osbUser)

  Delete a OSB user from the database.
  

• void lock (const Session &session, const OSB_LIB::OsbUser &osbUser)

  Lock the OSB user in the database.
  

Friends

• class OSB_LIB::OsbUser

  Let the gateway set the data members directly.
  

---

Member Function Documentation

void OSB_DB::OsbUserGw::fetch	(	const Session &	session,
		OSB_LIB::Users &	osbUsers
	)

Read all OSB users from the database.

Parameters:

	session	Database session to use.
	osbUsers	List of OSB users to populate.

bool OSB_DB::OsbUserGw::fetch	(	const Session &	session,
		OSB_LIB::OsbUser &	osbUser
	)

Read a OSB user from the database.

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

Parameters:

	session	Database session to use.
	osbUser	OSB user to be fetched, either its object or login name must be set.

Returns:

true if the OSB user was read from the database, else false. In the latter case the 'osbUser' remains unchanged.

void OSB_DB::OsbUserGw::insert	(	const Session &	session,
		OSB_LIB::OsbUser &	osbUser
	)			[private]

Insert a OSB user into the database.

Before the function call, the OSB user 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.
	osbUser	OSB user to be inserted.

Exceptions:

OsbException

duplicate login name in case of OSB user data validation rules fail. if insertion fails (for unknown reasons)

void OSB_DB::OsbUserGw::lock	(	const Session &	session,
		const OSB_LIB::OsbUser &	osbUser
	)			[private]

Lock the OSB user in the database.

Parameters:

	session	Database session to use.
	osbUser	OSB user to lock.

Exceptions:

	ObjectModified	if the object version does not match.
	ObjectDeleted	if the uses does not exist in the database.

void OSB_DB::OsbUserGw::remove	(	const Session &	session,
		OSB_LIB::OsbUser &	osbUser
	)			[private]

Delete a OSB user from the database.

Parameters:

	session	Database session to use.
	osbUser	OSB user to be inserted.

Exceptions:

	ObjectModified	if the object version does not match.
	ObjectDeleted	if the uses does not exist in the database.
	OsbException	if deleting fails (for unknown reasons)

void OSB_DB::OsbUserGw::update	(	const Session &	session,
		OSB_LIB::OsbUser &	osbUser
	)			[private]

Update a OSB user in the database.

Parameters:

	session	Database session to use.
	osbUser	OSB user to be inserted.

Exceptions:

	OsbException	duplicate login name in case of OSB user data validation rules fail. if the update fails (for unknown reasons)
	ObjectModified	if the object version does not match.
	ObjectDeleted	if the uses does not exist in the database.

The object version is incremented after the successful update.

---

Friends And Related Function Documentation

friend class OSB_LIB::OsbUser [friend]

Let the gateway set the data members directly.

Definition at line 59 of file osbuser-gw.h.

---

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

• osbuser-gw.h

---