OSB_LIB::Pricelist Class Reference

Collaboration diagram for OSB_LIB::Pricelist:

[legend]List of all members.

---

Detailed Description

The class Pricelist stores the name and description of a pricelist.

Definition at line 355 of file pricelist.h.

Public Types

• typedef Id< Pricelist > Oid

  Type-safe, unique id of price list.
  

Public Member Functions

• Pricelist ()

  Default constructor.
  

• Pricelist (const Oid &id, const std::string &name, const std::string &des)

  Copy, destructor and assignment by compiler.
  

Read access to data members.

• const Oid & oid () const

  Unique id of a pricelist.
  

• const std::string & name () const

  Name of pricelist.
  

• const std::string & desc () const

  Description of pricelist.
  

• long objVs () const

  Object version of pricelist.
  

Modify data members

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

  Set name of pricelist.
  

• void setDesc (const std::string &desc)

  Set description of pricelist.
  

Private Member Functions

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

  Check that the object has the latest object version.
  

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

  Read a pricelist from the database.
  

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

  Insert a pricelist into the database.
  

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

  Update a pricelist into the database.
  

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

  Remove a pricelist into the database.
  

Private Attributes

• Oid id_

  Price list id.
  

• std::string name_

  Name of price list.
  

• std::string des_

  Description of price list.
  

• long objVs_

  Object version of pricelist.
  

Friends

• class ProductCatalogue

  Allow product catalogue to access read and insert function.
  

• class OSB_DB::PricelistGw

  Allow gateway access to private members.
  

---

Member Typedef Documentation

typedef Id<Pricelist> OSB_LIB::Pricelist::Oid

Type-safe, unique id of price list.

Definition at line 362 of file pricelist.h.

---

Constructor & Destructor Documentation

OSB_LIB::Pricelist::Pricelist

(

)

[inline]

Default constructor.

Definition at line 365 of file pricelist.h.

OSB_LIB::Pricelist::Pricelist	(	const Oid &	id,
		const std::string &	name,
		const std::string &	des
	)			[inline]

Copy, destructor and assignment by compiler.

Definition at line 368 of file pricelist.h.

---

Member Function Documentation

void OSB_LIB::Pricelist::checkObjVs

(

const OSB_DB::Session &

session

)

[private]

Check that the object has the latest object version.

const std::string& OSB_LIB::Pricelist::desc

(

)

const [inline]

Description of pricelist.

Definition at line 381 of file pricelist.h.

References des_.

bool OSB_LIB::Pricelist::insert

(

const OSB_DB::Session &

session

)

[private]

Insert a pricelist into the database.

Parameters:

session

Database session.

Returns:

True if price list was inserted successfully.

const std::string& OSB_LIB::Pricelist::name

(

)

const [inline]

Name of pricelist.

Definition at line 379 of file pricelist.h.

References name_.

long OSB_LIB::Pricelist::objVs

(

)

const [inline]

Object version of pricelist.

Definition at line 383 of file pricelist.h.

References objVs_.

const Oid& OSB_LIB::Pricelist::oid

(

)

const [inline]

Unique id of a pricelist.

Definition at line 377 of file pricelist.h.

References id_.

bool OSB_LIB::Pricelist::read

(

const OSB_DB::Session &

session

)

[private]

Read a pricelist from the database.

Parameters:

session

Database session.

Returns:

True if price list was read successfully.

bool OSB_LIB::Pricelist::remove

(

const OSB_DB::Session &

session

)

[private]

Remove a pricelist into the database.

Parameters:

session

Database session.

Returns:

True if price list was removed successfully.

void OSB_LIB::Pricelist::setDesc

(

const std::string &

desc

)

[inline]

Set description of pricelist.

Definition at line 391 of file pricelist.h.

References des_.

void OSB_LIB::Pricelist::setName

(

const std::string &

name

)

[inline]

Set name of pricelist.

Definition at line 389 of file pricelist.h.

References name_.

bool OSB_LIB::Pricelist::update

(

const OSB_DB::Session &

session

)

[private]

Update a pricelist into the database.

Parameters:

session

Database session.

Returns:

True if price list was updated successfully.

---

Friends And Related Function Documentation

friend class OSB_DB::PricelistGw [friend]

Allow gateway access to private members.

Definition at line 359 of file pricelist.h.

friend class ProductCatalogue [friend]

Allow product catalogue to access read and insert function.

Definition at line 357 of file pricelist.h.

---

Member Data Documentation

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

Description of price list.

Definition at line 431 of file pricelist.h.

Referenced by desc(), and setDesc().

Oid OSB_LIB::Pricelist::id_ [private]

Price list id.

Definition at line 429 of file pricelist.h.

Referenced by oid().

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

Name of price list.

Definition at line 430 of file pricelist.h.

Referenced by name(), and setName().

long OSB_LIB::Pricelist::objVs_ [private]

Object version of pricelist.

Definition at line 432 of file pricelist.h.

Referenced by objVs().

---

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

• pricelist.h

---