OSB_LIB::UserGroups Class Reference

Collaboration diagram for OSB_LIB::UserGroups:

[legend]List of all members.

---

Detailed Description

List of user groups.

The class provides read-only access to all OSB user groups.

See also:

UserMgmtCfg Manager class to create, modify or delete user groups.

Definition at line 253 of file osbusrgrp.h.

Public Types

• typedef std::list< UserGroup > Cont

  STL container used to store the groups, it is sort by the user groups' names.
  

• typedef Cont::const_iterator ConstIter

  Const iterator into list of groups.
  

Public Member Functions

• bool empty () const

  List of user groups empty?
  

• size_t size () const

  Number of user groups in the list.
  

• ConstIter begin () const

  Get iterator to begin of list.
  

• ConstIter end () const

  Get iterator to end of list.
  

• const UserGroup & get (const UserGroup::Oid &grpId) const

  Get a user group.
  

• void read (const OSB_DB::Session &session)

  Read the user groups from the database.
  

Private Member Functions

• UserGroup & get (const UserGroup::Oid &grpId)

  Get a user group.
  

• void insert (const UserGroup &grp)

  Insert a group into the list.
  

• void remove (const UserGroup::Oid grpId)

  Remove a group from the list.
  

• UserGroup * find (const UserGroup::Oid &grpId)

  Find a user group.
  

Private Attributes

• Cont cont_

  List of user groups.
  

Friends

• class UserMgmtCfg

  Allow insert(), find() and remove().
  

• class OSB_DB::UserGroupGw

  Allow the gateway to call insert().
  

---

Member Typedef Documentation

typedef Cont::const_iterator OSB_LIB::UserGroups::ConstIter

Const iterator into list of groups.

Definition at line 265 of file osbusrgrp.h.

typedef std::list<UserGroup> OSB_LIB::UserGroups::Cont

STL container used to store the groups, it is sort by the user groups' names.

Definition at line 263 of file osbusrgrp.h.

---

Member Function Documentation

ConstIter OSB_LIB::UserGroups::begin

(

)

const

Get iterator to begin of list.

bool OSB_LIB::UserGroups::empty

(

)

const

List of user groups empty?

ConstIter OSB_LIB::UserGroups::end

(

)

const

Get iterator to end of list.

UserGroup* OSB_LIB::UserGroups::find

(

const UserGroup::Oid &

grpId

)

[private]

Find a user group.

UserGroup& OSB_LIB::UserGroups::get

(

const UserGroup::Oid &

grpId

)

[private]

Get a user group.

Parameters:

grpId

The object id of the user group.

Returns:

The user group for grpId.

Exceptions:

ObjectNotFound

if the user group is not found.

const UserGroup& OSB_LIB::UserGroups::get

(

const UserGroup::Oid &

grpId

)

const

Get a user group.

Parameters:

grpId

The object id of the user group.

Returns:

The user group for grpId.

Exceptions:

ObjectNotFound

if the user group is not found.

void OSB_LIB::UserGroups::insert

(

const UserGroup &

grp

)

[private]

Insert a group into the list.

Parameters:

grp

The user group to insert, it replaces an already existing group with the same object id.

void OSB_LIB::UserGroups::read

(

const OSB_DB::Session &

session

)

Read the user groups from the database.

void OSB_LIB::UserGroups::remove

(

const UserGroup::Oid

grpId

)

[private]

Remove a group from the list.

Parameters:

grpId

Object id for the user group to remove.

size_t OSB_LIB::UserGroups::size

(

)

const

Number of user groups in the list.

---

Friends And Related Function Documentation

friend class OSB_DB::UserGroupGw [friend]

Allow the gateway to call insert().

Definition at line 257 of file osbusrgrp.h.

friend class UserMgmtCfg [friend]

Allow insert(), find() and remove().

Definition at line 255 of file osbusrgrp.h.

---

Member Data Documentation

Cont OSB_LIB::UserGroups::cont_ [private]

List of user groups.

Definition at line 320 of file osbusrgrp.h.

---

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

• osbusrgrp.h

---