OSB_LIB::RatedPartyType Class Reference

Collaboration diagram for OSB_LIB::RatedPartyType:

[legend]List of all members.

---

Detailed Description

Description of a rated party.

Definition at line 69 of file ratedpartytype.h.

Public Member Functions

• RatedPartyType (Type type)
• const Type & type () const

  Get the type of the rated party.
  

• const std::string & name () const

  Get the name for the rated party.
  

• const std::string & des () const

  Get the description of the rated party.
  

• void setName (const std::string &name)

  Set the name for the rated party.
  

• void setDes (const std::string &des)

  Set the description of the rated party.
  

• bool operator< (const RatedPartyType &rhs) const

  Compare rated party types by type().
  

Private Types

• typedef TypeId< RatedParty > Type

  Short-hand for the rated party type.
  

Private Member Functions

Database operations:

The functions can only be called by RatedPartyTypes.

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

  Create or update a rated party type in the database.
  

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

  Delete a rated party type from the database.
  

Private Attributes

• Type type_

  The type of the rated party.
  

• std::string name_

  Name of the rated party.
  

• std::string des_

  Optional description of the rated party.
  

Friends

• class RatedPartyTypes

  Allow to call save() and remove().
  

• class OSB_DB::RatedPartyTypeGw

  Give the database gateway access to type and allow set the data members.
  

---

Member Typedef Documentation

typedef TypeId<RatedParty> OSB_LIB::RatedPartyType::Type [private]

Short-hand for the rated party type.

Definition at line 78 of file ratedpartytype.h.

---

Constructor & Destructor Documentation

OSB_LIB::RatedPartyType::RatedPartyType

(

Type

type

)

[explicit]

---

Member Function Documentation

const std::string& OSB_LIB::RatedPartyType::des

(

)

const

Get the description of the rated party.

const std::string& OSB_LIB::RatedPartyType::name

(

)

const

Get the name for the rated party.

bool OSB_LIB::RatedPartyType::operator<

(

const RatedPartyType &

rhs

)

const [inline]

Compare rated party types by type().

Definition at line 224 of file ratedpartytype.h.

References type().

void OSB_LIB::RatedPartyType::remove

(

const OSB_DB::Session &

session

)

const [private]

Delete a rated party type from the database.

Parameters:

session

Database session to use.

Exceptions:

OsbException

the type() is used elsewhere (foreign key violation).

void OSB_LIB::RatedPartyType::save

(

const OSB_DB::Session &

session

)

const [private]

Create or update a rated party type in the database.

Parameters:

session

Database session to use.

Exceptions:

OsbException

if type() is duplicate.

void OSB_LIB::RatedPartyType::setDes

(

const std::string &

des

)

Set the description of the rated party.

void OSB_LIB::RatedPartyType::setName

(

const std::string &

name

)

Set the name for the rated party.

const RatedPartyType::Type & OSB_LIB::RatedPartyType::type

(

)

const [inline]

Get the type of the rated party.

Definition at line 219 of file ratedpartytype.h.

References type_.

Referenced by operator<().

---

Friends And Related Function Documentation

friend class OSB_DB::RatedPartyTypeGw [friend]

Give the database gateway access to type and allow set the data members.

Definition at line 76 of file ratedpartytype.h.

friend class RatedPartyTypes [friend]

Allow to call save() and remove().

Definition at line 71 of file ratedpartytype.h.

---

Member Data Documentation

std::string OSB_LIB::RatedPartyType::des_ [private]

Optional description of the rated party.

Definition at line 124 of file ratedpartytype.h.

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

Name of the rated party.

Definition at line 122 of file ratedpartytype.h.

Type OSB_LIB::RatedPartyType::type_ [private]

The type of the rated party.

Definition at line 120 of file ratedpartytype.h.

Referenced by type().

---

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

• ratedpartytype.h

---