OSB_LIB::RateCode Class Reference

Inheritance diagram for OSB_LIB::RateCode:

[legend]Collaboration diagram for OSB_LIB::RateCode:

[legend]List of all members.

---

Detailed Description

Provide reason for rating.

Remarks:

Because of it's simplicity the class does not provide functions to read, create, modify or delete rate codes in the database. This functionality is provided by RateCodes.

Definition at line 77 of file tariff.h.

Public Types

• typedef Id< RateCode > Oid

  Typesafe object identification.
  

Public Member Functions

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

  Constructor with optional object id.
  

• const Oid & oid () const

  Get object id.
  

• const std::string & mnemonic () const

  Get mnemonic.
  

• void setMnemonic (const std::string &mnemonic)

  Set the mnemonic.
  

Private Attributes

• Oid oid_

  Typesafe object id, database link.
  

• std::string mnemonic_

  3 letter mnemonic to print on the invoice.
  

Friends

• class OSB_DB::RateCodeGw

  Allow the gateway to set the name and description.
  

---

Member Typedef Documentation

typedef Id<RateCode> OSB_LIB::RateCode::Oid

Typesafe object identification.

Definition at line 82 of file tariff.h.

---

Constructor & Destructor Documentation

OSB_LIB::RateCode::RateCode

(

const Oid &

oid = Oid()

)

[explicit]

Constructor with optional object id.

---

Member Function Documentation

const std::string& OSB_LIB::RateCode::mnemonic

(

)

const

Get mnemonic.

const Oid& OSB_LIB::RateCode::oid

(

)

const

Get object id.

void OSB_LIB::RateCode::setMnemonic

(

const std::string &

mnemonic

)

Set the mnemonic.

Parameters:

mnemonic

New mnemonic of the rating code. It is trucated to 3 letters.

---

Friends And Related Function Documentation

friend class OSB_DB::RateCodeGw [friend]

Allow the gateway to set the name and description.

Definition at line 79 of file tariff.h.

---

Member Data Documentation

std::string OSB_LIB::RateCode::mnemonic_ [private]

3 letter mnemonic to print on the invoice.

Definition at line 102 of file tariff.h.

Oid OSB_LIB::RateCode::oid_ [private]

Typesafe object id, database link.

Definition at line 100 of file tariff.h.

---

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

• tariff.h

---