OSB_LIB::Users Class Reference

Collaboration diagram for OSB_LIB::Users:

[legend]List of all members.

---

Detailed Description

List of users.

The class provides read-only access to all OSB users.

See also:

UserMgmtCfg Manager class to create, modify or delete users.

Definition at line 321 of file osbuser.h.

Public Types

• typedef std::list< OsbUser > Cont

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

• typedef Cont::const_iterator ConstIter

  Const iterator into list of users.
  

Public Member Functions

• Users ()

  Default constructor.
  

• bool empty () const

  List of users empty?
  

• size_t size () const

  Number of users in the list.
  

• ConstIter begin () const

  Get iterator to begin of list.
  

• ConstIter end () const

  Get iterator to end of list.
  

• const OsbUser & get (const OsbUser::Oid usrId) const

  Get a user.
  

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

  Read the users from the database.
  

• bool usersRead () const

  All users read from the database?
  

Private Member Functions

• void insert (const OsbUser &usr)

  Insert a user into the list.
  

• void remove (Cont::iterator usrIter)

  Remove a user from the list.
  

• Cont::iterator find (const OsbUser::Oid usrId)

  Find a user.
  

Private Attributes

• Cont users_

  List of users.
  

• bool usersRead_

  All users read from the database?
  

Friends

• class UserMgmtCfg

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

• class OSB_DB::OsbUserGw

  Allow the gateway to call insert().
  

---

Member Typedef Documentation

typedef Cont::const_iterator OSB_LIB::Users::ConstIter

Const iterator into list of users.

Definition at line 333 of file osbuser.h.

typedef std::list<OsbUser> OSB_LIB::Users::Cont

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

Definition at line 331 of file osbuser.h.

---

Constructor & Destructor Documentation

OSB_LIB::Users::Users

(

)

Default constructor.

---

Member Function Documentation

ConstIter OSB_LIB::Users::begin

(

)

const

Get iterator to begin of list.

bool OSB_LIB::Users::empty

(

)

const

List of users empty?

ConstIter OSB_LIB::Users::end

(

)

const

Get iterator to end of list.

Cont::iterator OSB_LIB::Users::find

(

const OsbUser::Oid

usrId

)

[private]

Find a user.

const OsbUser& OSB_LIB::Users::get

(

const OsbUser::Oid

usrId

)

const

Get a user.

Parameters:

usrId

The object id of the user.

Returns:

The user for usrId.

Exceptions:

ObjectNotFound

if the user is not found.

void OSB_LIB::Users::insert

(

const OsbUser &

usr

)

[private]

Insert a user into the list.

Parameters:

usr

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

void OSB_LIB::Users::read

(

const OSB_DB::Session &

session

)

Read the users from the database.

void OSB_LIB::Users::remove

(

Cont::iterator

usrIter

)

[private]

Remove a user from the list.

Parameters:

usrIter

Iterator to the user to remove.

size_t OSB_LIB::Users::size

(

)

const

Number of users in the list.

bool OSB_LIB::Users::usersRead

(

)

const

All users read from the database?

---

Friends And Related Function Documentation

friend class OSB_DB::OsbUserGw [friend]

Allow the gateway to call insert().

Definition at line 325 of file osbuser.h.

friend class UserMgmtCfg [friend]

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

Definition at line 323 of file osbuser.h.

---

Member Data Documentation

Cont OSB_LIB::Users::users_ [private]

List of users.

Definition at line 384 of file osbuser.h.

bool OSB_LIB::Users::usersRead_ [private]

All users read from the database?

Definition at line 386 of file osbuser.h.

---

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

• osbuser.h

---