OSB_LIB::PricelistItem Class Reference

Inheritance diagram for OSB_LIB::PricelistItem:

[legend]Collaboration diagram for OSB_LIB::PricelistItem:

Detailed Description

Product item to select a price list.

This product item stores a list of price lists available for a product, one of the price lists may be marked as the default for personalization.

Remarks:: Copy constructor and assignment by compiler.

Definition at line 75 of file plitem.h.

Public Types

typedef std::auto_ptr< PricelistItem > AutoPtr
Short-cut for an auto pointer.

Public Member Functions

PricelistItem (const Oid &oid, const std::string &name="", const std::string &des="")
Constructor with object id, name and description.
PricelistItem (const Oid &oid, const std::string &name, const std::string &des, const Id< Pricelist > &plId)
Constructor with full attribute.
AutoPtr clone () const
Virtual copy construction.
Type type () const
The type of the product item.
std::auto_ptr< PersProductItem > crePersProductItem () const
No personalization is availble for this class.
ProductItem::CfgType canConfigure () const
The configuration type of price list item: mandatory.
ProductItem::DefPersType canDefPers () const
The default personalization type of price list item: none.
CfgPersType canPersonalize () const
The personalization type of price list item: none.
const PersProductItem * defPersItem () const
Pointer to the default personalize product item.

Read access to data member:

const Id< Pricelist > & plId () const
Retrieve the price list id.

Modify data members:

void setPlId (const Id< Pricelist > &plId)
Set the price list id.

Static Public Attributes

static const Type type_
The product item type id: PiType::piPricelist.

Private Member Functions

ProductItem * clone_ () const
Virtual copy construction.

Database operations

All the database operations on price list items do not commit or rollback the transactions. This is indicated by taking a const OSB_DB::Session as argument.

bool readSpecific (const OSB_DB::Session &session)
(Re)read a price list item from the database.
bool insSpecific (const OSB_DB::Session &session)
Insert a price list item to the database.
bool updSpecific (const OSB_DB::Session &session)
Update a price list item in the database.
bool delSpecific (const OSB_DB::Session &session)
Delete a price list item from the database.

Private Attributes

Id< Pricelist > plId_
Object id of price list contained in this price list item.

Friends

class OSB_DB::PricelistItemGw
The database gateway needs to populate data members after construction.

Member Typedef Documentation

typedef std::auto_ptr<PricelistItem> OSB_LIB::PricelistItem::AutoPtr

Short-cut for an auto pointer.

For details see quality manual, implementation patterns: Virtual copy construction.

Reimplemented from OSB_LIB::ProductItem.

Definition at line 87 of file plitem.h.

Constructor & Destructor Documentation

OSB_LIB::PricelistItem::PricelistItem	(	const Oid &	oid,
		const std::string &	name = `""`,
		const std::string &	des = `""`
	)

Constructor with object id, name and description.

Parameters:

	oid	Product item object id.
	name	Name of the price list item.
	des	Description of the price list item.

OSB_LIB::PricelistItem::PricelistItem	(	const Oid &	oid,
		const std::string &	name,
		const std::string &	des,
		const Id< Pricelist > &	plId
	)

Constructor with full attribute.

Parameters:

	oid	Product item object id.
	name	Name of the price list item.
	des	Description of the price list item.
	plId	Object id of price list.

Member Function Documentation

ProductItem::CfgType OSB_LIB::PricelistItem::canConfigure ( ) const [virtual]

The configuration type of price list item: mandatory.

Implements OSB_LIB::ProductItem.

ProductItem::DefPersType OSB_LIB::PricelistItem::canDefPers ( ) const [virtual]

The default personalization type of price list item: none.

Implements OSB_LIB::ProductItem.

CfgPersType OSB_LIB::PricelistItem::canPersonalize ( ) const [virtual]

The personalization type of price list item: none.

Implements OSB_LIB::ProductItem.

AutoPtr OSB_LIB::PricelistItem::clone ( ) const

Virtual copy construction.

For details see quality manual, implementation patterns.

Reimplemented from OSB_LIB::ProductItem.

ProductItem* OSB_LIB::PricelistItem::clone_ ( ) const [private, virtual]

Virtual copy construction.

For details see quality manual, implementation patterns.

Implements OSB_LIB::ProductItem.

std::auto_ptr<PersProductItem> OSB_LIB::PricelistItem::crePersProductItem ( ) const [virtual]

No personalization is availble for this class.

Returns:: The function returns an empty auto pointer.

Implements OSB_LIB::ProductItem.

const PersProductItem* OSB_LIB::PricelistItem::defPersItem ( ) const [virtual]

Pointer to the default personalize product item.

Implements OSB_LIB::ProductItem.

bool OSB_LIB::PricelistItem::delSpecific ( const OSB_DB::Session & session ) [private, virtual]

Delete a price list item from the database.

The function uses a OSB_DB::PricelistItemGw to remove data.

Parameters:

session

Database session to use.

Returns:: true if the price list item was found and deleted from the database, else false.

Implements OSB_LIB::ProductItem.

bool OSB_LIB::PricelistItem::insSpecific ( const OSB_DB::Session & session ) [private, virtual]

Insert a price list item to the database.

The function uses a OSB_DB::PricelistItemGw to insert data member to the database.

Parameters:

session

Database session to use.

Returns:: true if the price list item was inserted into the database, else false.

Implements OSB_LIB::ProductItem.

const Id<Pricelist>& OSB_LIB::PricelistItem::plId ( ) const

Retrieve the price list id.

bool OSB_LIB::PricelistItem::readSpecific ( const OSB_DB::Session & session ) [private, virtual]

(Re)read a price list item from the database.

The function uses a OSB_DB::PricelistItemGw to read the data members.

Parameters:

session

Database session to use.

Returns:: Currently always true.

Implements OSB_LIB::ProductItem.

void OSB_LIB::PricelistItem::setPlId ( const Id< Pricelist > & plId )

Set the price list id.

Type OSB_LIB::PricelistItem::type ( ) const [inline, virtual]

The type of the product item.

The function returns the type of the product item. It is needed for only one reason: Corba clients must provide a configuration window that depends on the actual type.

No appropriate design can be provided: Unless on-line clients use the real product item type through-out the whole live cycle of an object, there must be a way to determine the actual type of a product item. No matter how clever we make our design, for on-line clients there will always be one step where they need to determine a product item's type in a switch-like statement. For this step I personally perfer to work with an enumeration type (and compiler warnings) rather than relying on dynamic casts (where errors can be detected only during run-time).