OSB_DB::PricelistGw

OSB_DB::PricelistGw Class Reference

List of all members.

Detailed Description

PricelistGw, database gateway to price list tables.

PricelistGw is the database gateway to the tables related to price lists: PRICELIST, PRICELIST_VERSION, ....
Only read operations are supported.

Definition at line 73 of file pricelist-gw.h.

Public Member Functions

Private Member Functions

Constructor & Destructor Documentation

OSB_DB::PricelistGw::PricelistGw (  )  [inline]

c'tor.

Definition at line 76 of file pricelist-gw.h.

Member Function Documentation

bool OSB_DB::PricelistGw::checkName ( const Session &  session,
const OSB_LIB::PricelistCfg &  plc 
) [private]

Check if the name of pricelist version already exist.

Parameters:
session Database session to use.
plc Reference to pricelist version.
Returns:
True if name does not already exist.

bool OSB_DB::PricelistGw::checkName ( const Session &  session,
const OSB_LIB::Pricelist &  pl 
) [private]

Check if the name of pricelist already exist.

Parameters:
session Database session to use.
pl Reference to pricelist.
Returns:
True if name does not already exist.

OSB_LIB::ObjectStatus OSB_DB::PricelistGw::checkObjVs ( const Session &  session,
const OSB_LIB::PricelistCfg &  plc 
)

Check that the object versions of a pricelist version in the object itself and the database are consistent.

Parameters:
session Session to use.
plc Price list version object to be checked.
Returns:
result of object version verification. Possible values are:
  • objUnchanged
  • objModified
  • objDeleted

OSB_LIB::ObjectStatus OSB_DB::PricelistGw::checkObjVs ( const Session &  session,
const OSB_LIB::Pricelist &  pl 
)

Check that the object versions of a pricelist in the object itself and the database are consistent.

Parameters:
session Session to use.
pl Price list object to be checked.
Returns:
result of object version verification. Possible values are:
  • objUnchanged
  • objModified
  • objDeleted

void OSB_DB::PricelistGw::delOtcDef ( const Session &  session,
const OSB_LIB::PricelistCfg &  plc 
) [private]

Delete all onetime charge definition of a pricelist configuration.

Parameters:
session Session to use.
plc Reference to one time charge definition.

bool OSB_DB::PricelistGw::delOtcDef ( const Session &  session,
const OSB_LIB::OnetimeChargeDef::Oid &  otcId 
)

Delete a onetime charge definition.

Parameters:
session Session to use.
otcId Unique id of one time charge definition.
Returns:
True if delete operation was successful.

bool OSB_DB::PricelistGw::delPricelist ( const Session &  session,
const OSB_LIB::Pricelist::Oid &  plId 
)

Delete a price list description.

Parameters:
session Session to use.
plId Unique id of price list to delete.
Returns:
True if delete is successful.

bool OSB_DB::PricelistGw::delPricelistCfg ( const Session &  session,
const OSB_LIB::PricelistCfg &  plc 
)

Delete a pricelist version.

Parameters:
session Session to use.
plc Reference to price list configuration to delete.
Returns:
True if delete is successful.

bool OSB_DB::PricelistGw::fetchOtcDef ( const Session &  session,
OSB_LIB::OnetimeChargeDef &  otc 
)

Read an onetime charge definition.

Parameters:
session Session to use.
otc Onetime charge definition to populate.
Returns:
True if fetch is successful.

bool OSB_DB::PricelistGw::fetchPricelist ( const Session &  session,
OSB_LIB::Pricelist &  pl 
)

Read a price list description.

Parameters:
session Session to use.
pl Price list to populate.
Returns:
True if fetch is successful.

long OSB_DB::PricelistGw::fetchPricelistCfg ( const Session &  session,
OSB_LIB::PricelistCfg &  plc 
)

Read a pricelist version.

Parameters:
session Session to use.
plc Price list configuration to populate.
Returns:
True if fetch is successful.

long OSB_DB::PricelistGw::fetchPricelistCfgs ( const Session &  session,
OSB_LIB::PricelistCfgs *  plcs 
)

read all pricelist versions.

Parameters:
session Session to use.
plcs Container to populate.
Returns:
number of rows processed.

long OSB_DB::PricelistGw::fetchPricelists ( const Session &  session,
OSB_LIB::Pricelists *  pls 
)

read all price list descriptions.

Parameters:
session Session to use.
pls Container to populate.
Returns:
number of constructed objects.

long OSB_DB::PricelistGw::fetchSubsChargeDefs ( const Session &  session,
OSB_LIB::SubsFuncCfg *  sfc 
)

read subs. charge definition of a subscription function.

Parameters:
session Session to use.
sfc Subs. function to read for and to store result.
Returns:
number of subscription charge definitions read.

long OSB_DB::PricelistGw::fetchSubsFuncCfgs ( const Session &  session,
OSB_LIB::SubsFuncCfgs *  sfc 
)

read subscription function configurations.

Parameters:
session Session to use.
sfc list to populate.
Returns:
number of subscription functions read.

OSB_LIB::CfgStatus OSB_DB::PricelistGw::getStatus ( const Session &  session,
const OSB_LIB::PricelistCfg::Oid &  plcId 
)

Get the status of a pricelist version.

Parameters:
session Session to use.
plcId Unique id pricelist version.
Returns:
Status of pricelist version.

bool OSB_DB::PricelistGw::insOtcDef ( const Session &  session,
OSB_LIB::OnetimeChargeDef &  otc 
)

Insert a onetime charge definition.

Parameters:
session Session to use.
otc Onetime charge definition to insert.
Returns:
True if insert is successful.

bool OSB_DB::PricelistGw::insPricelist ( const Session &  session,
OSB_LIB::Pricelist &  pl 
)

Insert a new price list description.

Parameters:
session Session to use.
pl Price list to insert.
Returns:
True if insert is successful.

long OSB_DB::PricelistGw::insPricelistCfg ( const Session &  session,
OSB_LIB::PricelistCfg &  plc 
)

Insert a pricelist version.

Parameters:
session Session to use.
plc Price list configuration to insert.
Returns:
True if insert is successful.

void OSB_DB::PricelistGw::insPricelistOtc ( const Session &  session,
const OSB_LIB::PricelistCfg &  plc 
) [private]

Insert configuration of PricelistCfg into PRICELIST_OTC table.

Parameters:
session Database session to use.
plc Reference to pricelist version.

bool OSB_DB::PricelistGw::setStatus ( const Session &  session,
const OSB_LIB::PricelistCfg &  plc,
const OSB_LIB::CfgStatus &  status 
)

Set the status of a pricelist version.

Parameters:
session Session to use.
plc Reference of Pricelist version.
status New status to changed to.
Returns:
True if status change is successful.

bool OSB_DB::PricelistGw::updPricelist ( const Session &  session,
const OSB_LIB::Pricelist &  pl 
)

Update a new price list description.

Parameters:
session Session to use.
pl Price list to update.
Returns:
True if update is successful.

bool OSB_DB::PricelistGw::updPricelistCfg ( const Session &  session,
const OSB_LIB::PricelistCfg &  plc 
)

Update a pricelist version.

Parameters:
session Session to use.
plc Price list configuration to update.
Returns:
True if update is successful.

The documentation for this class was generated from the following file:
Generated on Sat Sep 2 14:09:02 2006 for OSB Library by  doxygen 1.4.7