OSB_LIB::ServiceClass Class Reference

Inheritance diagram for OSB_LIB::ServiceClass:

[legend]Collaboration diagram for OSB_LIB::ServiceClass:

[legend]List of all members.

---

Detailed Description

Service class is used to identify the tariff class applicable in order to rate the used service.

This object represent a service category. Every used service will belong to a specific service class. Then a tariff system will be selected to rate the service used.

Definition at line 79 of file serviceclass.h.

Public Types

• typedef Id< ServiceClass > Oid

  Typesave object identification.
  

Public Member Functions

• ServiceClass (const Oid &oid=Oid())

  Constructor with optional object id.
  

• const Oid & oid () const

  Return the object id of this object.
  

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

  Read a service class from database.
  

Private Member Functions

Modifying database operations:

• bool insert (const OSB_DB::Session &session)

  Insert a service class into database.
  

• bool update (const OSB_DB::Session &session)

  Update a service class in the database.
  

• bool remove (const OSB_DB::Session &session)

  Remove a service class from database.
  

Private Attributes

• Oid oid_

  Database id of this object.
  

Friends

• struct OSB_DB::ServiceClassGw

  The database gateway needs to populate data members after construction.
  

• class TariffCatalogue

  Tariff Catalogue is the only object that is allow to invoke the private functions of this class.
  

---

Member Typedef Documentation

typedef Id<ServiceClass> OSB_LIB::ServiceClass::Oid

Typesave object identification.

Definition at line 93 of file serviceclass.h.

---

Constructor & Destructor Documentation

OSB_LIB::ServiceClass::ServiceClass

(

const Oid &

oid = Oid()

)

[inline]

Constructor with optional object id.

Definition at line 96 of file serviceclass.h.

---

Member Function Documentation

bool OSB_LIB::ServiceClass::insert

(

const OSB_DB::Session &

session

)

[private]

Insert a service class into database.

A new object is inserted. All attribute of the object has been set except object id. The object id will only be set by the function if the insertion is successful.

Parameters:

session

Database session.

Returns:

true if success else false.

Exceptions:

OsbException

for the following errors: Duplicate name.

const Oid& OSB_LIB::ServiceClass::oid

(

)

const

Return the object id of this object.

bool OSB_LIB::ServiceClass::read

(

const OSB_DB::Session &

session

)

Read a service class from database.

The object id is used to gather other info from database and then populate the object's service tuple list.

Parameters:

session

Database session.

Returns:

true if success else false.

bool OSB_LIB::ServiceClass::remove

(

const OSB_DB::Session &

session

)

[private]

Remove a service class from database.

After the function call, oid of this object will be unset to indicate that there is no such entry anymore in the database.

Parameters:

session

Database session.

Returns:

true if success else false.

Exceptions:

OsbException

for the following errors: Object does not exist.

bool OSB_LIB::ServiceClass::update

(

const OSB_DB::Session &

session

)

[private]

Update a service class in the database.

Old entry in the database identify by the object id will be replaced with the new data from this object.

Parameters:

session

Database session.

Returns:

true if success else false.

Exceptions:

OsbException

for the following errors: Object does not exist.

---

Friends And Related Function Documentation

friend struct OSB_DB::ServiceClassGw [friend]

The database gateway needs to populate data members after construction.

Definition at line 84 of file serviceclass.h.

friend class TariffCatalogue [friend]

Tariff Catalogue is the only object that is allow to invoke the private functions of this class.

Definition at line 90 of file serviceclass.h.

---

Member Data Documentation

Oid OSB_LIB::ServiceClass::oid_ [private]

Database id of this object.

Definition at line 159 of file serviceclass.h.

---

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

• serviceclass.h

---