OSB_LIB::Module Class Reference

Collaboration diagram for OSB_LIB::Module:

[legend]List of all members.

---

Detailed Description

Information about an OSB module (application).

Definition at line 71 of file modules.h.

• void lock (const OSB_DB::Session &session, bool noWait) const

  Lock the module in the database.
  

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

  Increment the object version by 1.
  

• static void handleObjectStatus (ObjectStatus os, const Oid &id)

  Evalute the object status of the module.
  

Public Types

• typedef Id< ModuleId > Oid

  Typesafe object identification.
  

Public Member Functions

• Module (const Oid &oid)

  Constructor with object id.
  

• ~Module ()

  Destructor: delete accessMap_.
  

• Module (const Module &rhs)

  Copy constructor: copy accessMap_.
  

• Module & operator= (const Module &rhs)

  Assignment: copy accessMap_.
  

• Oid oid () const

  Get the object id.
  

• ModuleId modId () const

  Get the module id.
  

• const std::string & name () const

  Get the name.
  

• const std::string appType () const

  Get the application type.
  

• const ModAccessMap & accessMap () const

  Get the access rights defined for the module.
  

Private Attributes

• Oid oid_

  Object id.
  

• long objVs_

  Object version.
  

• std::string name_

  Module name.
  

• std::string appType_

  Application type.
  

• ModAccessMap * accessMap_

  Access rights defined for the module.
  

Friends

• class UserMgmtCfg

  Allow non-const access to a module.
  

• class OSB_DB::ModuleGw

  Allow the gateway to set the data members.
  

---

Member Typedef Documentation

typedef Id<ModuleId> OSB_LIB::Module::Oid

Typesafe object identification.

Definition at line 79 of file modules.h.

---

Constructor & Destructor Documentation

OSB_LIB::Module::Module

(

const Oid &

oid

)

[explicit]

Constructor with object id.

OSB_LIB::Module::~Module

(

)

Destructor: delete accessMap_.

OSB_LIB::Module::Module

(

const Module &

rhs

)

Copy constructor: copy accessMap_.

---

Member Function Documentation

const ModAccessMap& OSB_LIB::Module::accessMap

(

)

const

Get the access rights defined for the module.

Unless UserMgmtCfg::readModuleAccess() was called the access map is empty.

const std::string OSB_LIB::Module::appType

(

)

const

Get the application type.

static void OSB_LIB::Module::handleObjectStatus	(	ObjectStatus	os,
		const Oid &	id
	)			[static, private]

Evalute the object status of the module.

Parameters:

	os	Object status to evaluate.
	id	The id of the module for which os is valid.

Exceptions:

	ObjectDeleted
	ObjectModified
	ObjectBusy

void OSB_LIB::Module::incObjVs

(

const OSB_DB::Session &

session

)

[private]

Increment the object version by 1.

Parameters:

session

Database session to use.

Exceptions:

OsbException

(internal error) if the update of the object version in the database fails.

The function should be used only after a successful call of lock().

void OSB_LIB::Module::lock	(	const OSB_DB::Session &	session,
		bool	noWait
	)			const [private]

Lock the module in the database.

Parameters:

	session	Database session to use.
	noWait	Don't wait for database locks?

Exceptions:

OsbException

from handleObjectStatus().

ModuleId OSB_LIB::Module::modId

(

)

const

Get the module id.

const std::string& OSB_LIB::Module::name

(

)

const

Get the name.

Oid OSB_LIB::Module::oid

(

)

const

Get the object id.

Module& OSB_LIB::Module::operator=

(

const Module &

rhs

)

Assignment: copy accessMap_.

---

Friends And Related Function Documentation

friend class OSB_DB::ModuleGw [friend]

Allow the gateway to set the data members.

Definition at line 75 of file modules.h.

friend class UserMgmtCfg [friend]

Allow non-const access to a module.

Definition at line 73 of file modules.h.

---

Member Data Documentation

ModAccessMap* OSB_LIB::Module::accessMap_ [private]

Access rights defined for the module.

Definition at line 160 of file modules.h.

std::string OSB_LIB::Module::appType_ [private]

Application type.

Definition at line 158 of file modules.h.

std::string OSB_LIB::Module::name_ [private]

Module name.

Definition at line 156 of file modules.h.

long OSB_LIB::Module::objVs_ [private]

Object version.

Definition at line 154 of file modules.h.

Oid OSB_LIB::Module::oid_ [private]

Object id.

Definition at line 152 of file modules.h.

---

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

• modules.h

---