OSB_LIB::RatedPartyTypes Class Reference

Collaboration diagram for OSB_LIB::RatedPartyTypes:

[legend]List of all members.

---

Detailed Description

List of rated party types.

Definition at line 130 of file ratedpartytype.h.

Database operations:

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

  Read all rated party types from the database.
  

• void replace (const OSB_DB::Session &session, const RatedPartyType &rpType)

  Create or update a rated party type.
  

• void remove (const OSB_DB::Session &session, const RatedPartyType &rpType)

  Delete a rated party type.
  

• Cont cont_

  STL container to store the rated party types.
  

Public Types

• typedef std::list< RatedPartyType > Cont

  STL container to store the rated party types.
  

Public Member Functions

• const RatedPartyType & get (const TypeId< RatedParty > &type)

  Get a specific rated party type.
  

• const RatedPartyType * find (const TypeId< RatedParty > &type)

  Get a specific rated party type.
  

• const Cont & rpTypes () const

  Get all rated party types.
  

• void sort ()

  Sort the rated party types by type.
  

• template<typename Comp> void sort (Comp comp)

  Sort the rated party types.
  

Friends

• class OSB_DB::RatedPartyTypeGw

  Allow the gateway to populate cont_.
  

---

Member Typedef Documentation

typedef std::list<RatedPartyType> OSB_LIB::RatedPartyTypes::Cont

STL container to store the rated party types.

Note:

std::list was choosen to allow sorting by type or name of the rated party type (see sort()).

Definition at line 140 of file ratedpartytype.h.

---

Member Function Documentation

const RatedPartyType* OSB_LIB::RatedPartyTypes::find

(

const TypeId< RatedParty > &

type

)

Get a specific rated party type.

Parameters:

type

The rated party type to retrieve.

Returns:

The rated party type for type,
it is 0 if the type does not exist.

const RatedPartyType& OSB_LIB::RatedPartyTypes::get

(

const TypeId< RatedParty > &

type

)

Get a specific rated party type.

Parameters:

type

The rated party type to retrieve.

Returns:

The rated party type for type.

Exceptions:

ObjectNotFound

with the type does not exist.

void OSB_LIB::RatedPartyTypes::read

(

const OSB_DB::Session &

session

)

Read all rated party types from the database.

Parameters:

session

Database session to use.

void OSB_LIB::RatedPartyTypes::remove	(	const OSB_DB::Session &	session,
		const RatedPartyType &	rpType
	)

Delete a rated party type.

Parameters:

	session	Database session to use.
	rpType	Rated party type to delete.

Exceptions:

OsbException

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

void OSB_LIB::RatedPartyTypes::replace	(	const OSB_DB::Session &	session,
		const RatedPartyType &	rpType
	)

Create or update a rated party type.

Parameters:

	session	Database session to use.
	rpType	Rated party type to create or update.

Exceptions:

OsbException

if the same rated party type was created by another user since the list was last read.

Attention:

Calls sort() after adding rpType to the list.

const Cont& OSB_LIB::RatedPartyTypes::rpTypes

(

)

const

Get all rated party types.

template<typename Comp>

void OSB_LIB::RatedPartyTypes::sort

(

Comp

comp

)

Sort the rated party types.

Parameters:

comp

Binary predicate used to sort cont_. A possible template is LessName.

Definition at line 231 of file ratedpartytype.h.

References cont_.

void OSB_LIB::RatedPartyTypes::sort

(

)

Sort the rated party types by type.

---

Friends And Related Function Documentation

friend class OSB_DB::RatedPartyTypeGw [friend]

Allow the gateway to populate cont_.

Definition at line 132 of file ratedpartytype.h.

---

Member Data Documentation

Cont OSB_LIB::RatedPartyTypes::cont_ [private]

STL container to store the rated party types.

Definition at line 210 of file ratedpartytype.h.

Referenced by sort().

---

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

• ratedpartytype.h

---