OSB_LIB::PricelistCfg Class Reference

Collaboration diagram for OSB_LIB::PricelistCfg:

[legend]List of all members.

Detailed Description

PricelistCfg defines the charges that are applicable for a product or product part.

Restrictions:

no support for version.

Definition at line 445 of file pricelist.h.

Public Types

typedef std::list< OnetimeChargeDef > OnetimeChargeDefs
List of onetime charge definitions.
typedef Id< Pricelist > PricelistId
Type-safe unique id of a price list.
typedef Id2< PricelistCfg > Oid
Type-safe unique id of a price list configuration.

Public Member Functions

PricelistCfg (const Oid &, const std::string &name="")
Copy constructor and assignment by compiler.
~PricelistCfg ()
const Oid & oid () const
const std::string & name () const
Return version name.
long objVs () const
Return object version.
const EventCharges & eventCharges () const
Return list of event charges.
CfgStatus status () const
Return status of PricelistCfg.
const Date & releaseDate () const
Return date when PricelistCfg was released.
const PricelistId pricelistId () const
Return id of price list.
const SubsFuncCfg::Oid subsFuncCfgId () const
Price list usage.
const OnetimeChargeDef * findOnetimeChargeDef (const OnetimeChargeDef::Oid &chargeId) const
Find a one-time charge.
const OnetimeChargeDefs & getOnetimeChargeDefs () const
Give read access to list of onetime charges definitions.
OnetimeChargeDefs & onetimeChargeDefs ()
Give write access to list of onetime charges definitions.
void setSubsFuncCfg (const SubsFuncCfg::Oid pCfg)
bool addOnetimeChargeDef (OSB_DB::Session &session, OnetimeChargeDef &otc)
Add a one-time charge.
int removeEventCharge (EventCharges::EventId eventId)
Remove a event - onetime charge.
int addEventCharge (EventCharges::EventId eventId, const OnetimeChargeDef::Oid &chargeId)
Add a link event - onetime charge.

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 configuration from the database.
bool insert (const OSB_DB::Session &session)
Insert a pricelist configuration into the database.
bool update (const OSB_DB::Session &session)
Update a pricelist configuration into the database.
bool remove (const OSB_DB::Session &session)
Remove a pricelist configuration into the database.
bool check (const OSB_DB::Session &session)
Change the status of a pricelist configuration into from edit to standby.
bool release (const OSB_DB::Session &session)
Change the status of a pricelist configuration into from standby to release.
bool revoke (const OSB_DB::Session &session)
Change the status of a pricelist configuration into from release to standby.
bool unfreeze (const OSB_DB::Session &session)
Change the status of a pricelist configuration into from standby to edit.

Private Attributes

Oid id_
Unique id: database link: Price list and version id.
std::string name_
Version name.
long objVs_
Object version.
SubsFuncCfg::Oid subsFuncCfgId_
Subscription function id.
CfgStatus status_
version status
Date releaseDate_
Date when the PricelistCfg was last released.
OnetimeChargeDefs onetimeCharges_
Master list of one-time charges.
EventCharges eventCharges_
Link events to one-time charges.

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 Id2<PricelistCfg> OSB_LIB::PricelistCfg::Oid

Type-safe unique id of a price list configuration.

Definition at line 459 of file pricelist.h.

typedef std::list<OnetimeChargeDef> OSB_LIB::PricelistCfg::OnetimeChargeDefs

List of onetime charge definitions.

Definition at line 453 of file pricelist.h.

typedef Id<Pricelist> OSB_LIB::PricelistCfg::PricelistId

Type-safe unique id of a price list.

Definition at line 456 of file pricelist.h.

Constructor & Destructor Documentation

OSB_LIB::PricelistCfg::PricelistCfg	(	const Oid &	,
		const std::string &	name = `""`
	)			`[explicit]`

Copy constructor and assignment by compiler.

OSB_LIB::PricelistCfg::~PricelistCfg ( ) [inline]

Definition at line 463 of file pricelist.h.

Member Function Documentation

int OSB_LIB::PricelistCfg::addEventCharge	(	EventCharges::EventId	eventId,
		const OnetimeChargeDef::Oid &	chargeId
	)

Add a link event - onetime charge.

bool OSB_LIB::PricelistCfg::addOnetimeChargeDef	(	OSB_DB::Session &	session,
		OnetimeChargeDef &	otc
	)

Add a one-time charge.

bool OSB_LIB::PricelistCfg::check ( const OSB_DB::Session & session ) [private]

Change the status of a pricelist configuration into from edit to standby.

Parameters:

session

Database session.

Returns:: True if status of price list configuration was changed successfully.

void OSB_LIB::PricelistCfg::checkObjVs ( const OSB_DB::Session & session ) [private]

Check that the object has the latest object version.

const EventCharges& OSB_LIB::PricelistCfg::eventCharges ( ) const [inline]

Return list of event charges.

Definition at line 479 of file pricelist.h.

References eventCharges_.

const OnetimeChargeDef* OSB_LIB::PricelistCfg::findOnetimeChargeDef ( const OnetimeChargeDef::Oid & chargeId ) const

Find a one-time charge.

const OnetimeChargeDefs& OSB_LIB::PricelistCfg::getOnetimeChargeDefs ( ) const [inline]

Give read access to list of onetime charges definitions.

Definition at line 505 of file pricelist.h.

References onetimeCharges_.

bool OSB_LIB::PricelistCfg::insert ( const OSB_DB::Session & session ) [private]

Insert a pricelist configuration into the database.

Parameters:

session

Database session.

Returns:: True if price list configuration was inserted successfully.

const std::string& OSB_LIB::PricelistCfg::name ( ) const [inline]

Return version name.

Definition at line 473 of file pricelist.h.

References name_.

long OSB_LIB::PricelistCfg::objVs ( ) const [inline]

Return object version.

Definition at line 476 of file pricelist.h.

References objVs_.

const Oid& OSB_LIB::PricelistCfg::oid ( ) const [inline]

Return unique id and version number of price list configuration.

Definition at line 470 of file pricelist.h.

References id_.

OnetimeChargeDefs& OSB_LIB::PricelistCfg::onetimeChargeDefs ( ) [inline]

Give write access to list of onetime charges definitions.

Definition at line 511 of file pricelist.h.

References onetimeCharges_.

const PricelistId OSB_LIB::PricelistCfg::pricelistId ( ) const [inline]

Return id of price list.

Definition at line 488 of file pricelist.h.

References OSB_LIB::Id2< I >::id1_, and id_.

bool OSB_LIB::PricelistCfg::read ( const OSB_DB::Session & session ) [private]

Read a pricelist configuration from the database.

Parameters:

session

Database session.

Returns:: True if price list configuration was read successfully.

bool OSB_LIB::PricelistCfg::release ( const OSB_DB::Session & session ) [private]

Change the status of a pricelist configuration into from standby to release.

Parameters:

session

Database session.

Returns:: True if status of price list configuration was changed successfully.

const Date& OSB_LIB::PricelistCfg::releaseDate ( ) const [inline]

Return date when PricelistCfg was released.

Definition at line 485 of file pricelist.h.

References releaseDate_.

bool OSB_LIB::PricelistCfg::remove ( const OSB_DB::Session & session ) [private]

Remove a pricelist configuration into the database.

Remarks:: Remove a pricelist configuration does not cause a removal of onetime charge definition. In other words, the onetime charge definition list is not maintained, it grows indefinitely.

Parameters:

session

Database session.