OSB_DB::UserGroupGw Class Reference

List of all members.

Detailed Description

Database gateway for OSB_LIB::UserGroup.

Definition at line 67 of file osbusrgrp-gw.h.

Public Member Functions

Private Member Functions

Locking and object version maintenance:

Friends


Member Function Documentation

void OSB_DB::UserGroupGw::fetch ( const Session session,
OSB_LIB::UserGroups dest 
)

Read all OSB user group from the database.

Parameters:
session Database session to use.
dest List of user groups to populate.

bool OSB_DB::UserGroupGw::fetch ( const Session session,
OSB_LIB::UserGroup group 
)

Read a OSB user group from the database.

The function (re)reads an existing user group from the database.

Parameters:
session Database session to use.
group User group to read, its object id must be set.
Returns:
true if the group was read from the database, else false.

bool OSB_DB::UserGroupGw::incObjVs ( const Session session,
OSB_LIB::UserGroup group 
) [private]

Increment the object version of a user group.

Parameters:
session Database session to use.
group The user group who's object version is increased.
Returns:
true if the object version of group was increased by 1, else false.

void OSB_DB::UserGroupGw::insert ( const Session session,
OSB_LIB::UserGroup group 
) [private]

Insert a user group.

Parameters:
session Database session to use.
group User group to insert, its object id is set.
Exceptions:
OsbException if a group with the same name exists.

OSB_LIB::ObjectStatus OSB_DB::UserGroupGw::lock ( const Session session,
const OSB_LIB::UserGroup group,
bool  noWait 
) [private]

Lock a user group in the database.

Parameters:
session Database session to use.
group The user group to lock.
noWait Don't wait if locked by another session?
Returns:
The object status of the user group.

OSB_LIB::ObjectStatus OSB_DB::UserGroupGw::lock ( const Session session,
const OSB_LIB::Id< OSB_LIB::UserGroup grpId,
bool  noWait 
) [private]

Lock a user group in database.

Parameters:
session Database session to use.
grpId Id of the user group to lock.
noWait Don't wait if locked by another session?
Returns:
The object status of the user group (modified is not applicable).

bool OSB_DB::UserGroupGw::remove ( const Session session,
const OSB_LIB::UserGroup group 
) [private]

Remove a user group from the database.

Parameters:
session Database session to use.
group User group to delete.
Exceptions:
OsbException if user belong to the group.
Removes the group and all its access rights from the database.

void OSB_DB::UserGroupGw::update ( const Session session,
const OSB_LIB::UserGroup group 
) [private]

Update a user group.

Parameters:
session Database session to use.
group User group to update.
Exceptions:
OsbException if a group with the same name exists.


Friends And Related Function Documentation

friend class OSB_LIB::UserGroup [friend]

Let the class call its database functions.

Definition at line 69 of file osbusrgrp-gw.h.


The documentation for this class was generated from the following file:
Generated on Sat Sep 2 14:08:57 2006 for OSB Library by  doxygen 1.4.7