OSB_CORBA::ProductCatalogue_i Class Reference

Inheritance diagram for OSB_CORBA::ProductCatalogue_i:

Inheritance graph
[legend]
Collaboration diagram for OSB_CORBA::ProductCatalogue_i:

Collaboration graph
[legend]
List of all members.

Detailed Description

Definition at line 84 of file productcatalogue_i.h.

Public Member Functions

Status changes on PricelistCfg.
Support for service elements:
Support for tariff systems:

Static Public Attributes

Private Member Functions

Private Attributes


Constructor & Destructor Documentation

OSB_CORBA::ProductCatalogue_i::ProductCatalogue_i ( const ServerInfo &  info,
PortableServer::POA_ptr  rootPoa,
PortableServer::POAManager_ptr  poaManager 
) throw (OsbCorbaException)


Member Function Documentation

Pricelist_ptr OSB_CORBA::ProductCatalogue_i::activatePricelist ( const OSB_LIB::Pricelist::Oid id  )  throw (CORBA::SystemException) [private]

Product_ptr OSB_CORBA::ProductCatalogue_i::activateProduct ( const OSB_LIB::Product::Oid id  )  throw (CORBA::SystemException) [private]

virtual CORBA::Boolean OSB_CORBA::ProductCatalogue_i::checkPricelistCfg ( const PricelistId &  pricelistId,
CORBA::Boolean  noWait 
) throw (CORBA::SystemException, OsbCorbaException) [virtual]

Change status of a price list configuration from editable to standby.

Parameters:
pricelistId The id of the pricelist
noWait Set to false if waiting is desired when lock is already acquired by others. If waiting is not desired, set flag to true.
Returns:
True if the pricelist configuration status was changed successfully.
Exceptions:
OsbCorbaException 
  • in case database error occurs.

void OSB_CORBA::ProductCatalogue_i::createPlPoa ( PortableServer::POA_ptr  rootPoa,
PortableServer::POAManager_ptr  poaManager 
) [private]

void OSB_CORBA::ProductCatalogue_i::createPoas ( PortableServer::POA_ptr  rootPoa,
PortableServer::POAManager_ptr  poaManager 
) [private]

void OSB_CORBA::ProductCatalogue_i::createPpPoa ( PortableServer::POA_ptr  rootPoa,
PortableServer::POAManager_ptr  poaManager 
) [private]

virtual CORBA::Boolean OSB_CORBA::ProductCatalogue_i::creChargeTraits ( const CurrencyCode &  currency,
const RoundRuleId &  rrId,
const Utf8String &  accCode,
const Utf8String &  numFormat,
const TaxKeyId &  tkId,
ChargeType  cType,
CORBA::Boolean  noWait,
ChargeTraits_out  chrgTraits 
) throw (CORBA::SystemException, OsbCorbaException) [virtual]

Create a new charge traits.

This function is a wrapper function around creChargeTraits in chargetraits_i.h in order to provide a guarded session. If such a configuration of the charge traits already exist, the unique id of the charge traits will be returned. If the charge traits does not exist, the charge traits will be created and the unique id of the newly created charge traits will be returned. If create is not successful, a charge triats with an id value of 0 will be returned.

Parameters:
currency Type-safe id of currency.
rrId Unique id of a round rule.
accCode Account code.
numFormat Number format of new charge traits.
tkId Unique id of tax key.
cType Charge type of new charge traits.
noWait Set to false if waiting is desired when lock is already acquired by others. If waiting is not desired, set flag to true.
chrgTraits Contains either an existing charge traits or a newly created one.
Returns:
True if a new charge traits is created else return false if an existing one is found.
Exceptions:
OsbCorbaException if operation fails.

virtual PricelistWriter_ptr OSB_CORBA::ProductCatalogue_i::crePricelist (  )  throw (CORBA::SystemException) [virtual]

Create a pricelist.

Returns:
The newly created, writeable pricelist.
Remarks:
The pricelist is saved permanently only after pd::PricelistWriter::commitChanges is called successfully.

virtual ProductWriter_ptr OSB_CORBA::ProductCatalogue_i::creProduct (  )  throw (CORBA::SystemException, OsbCorbaException) [virtual]

void OSB_CORBA::ProductCatalogue_i::deactivateObject ( const std::string &  id,
PortableServer::POA_ptr  poa 
) [private]

void OSB_CORBA::ProductCatalogue_i::deactivateObject ( const OSB_LIB::Product::Oid pdId  ) 

virtual void OSB_CORBA::ProductCatalogue_i::delPricelist ( const PricelistId &  id,
CORBA::Boolean  noWait 
) throw (CORBA::SystemException, OsbCorbaException) [virtual]

Deletes an existing pricelist.

Parameters:
id Id of the pricelist to delete.
noWait Set to false if waiting is desired when lock is already acquired by others. If waiting is not desired, set flag to true.
Exceptions:
OsbCorbaException 
  • if the pricelist does not exist
  • in case of any database errors
Remarks:
Deletion of pricelist also deletes the corresponding PricelistCfg if available.

virtual void OSB_CORBA::ProductCatalogue_i::delProduct ( const ProductId &  id  )  throw (CORBA::SystemException, OsbCorbaException) [virtual]

virtual Accounting_ptr OSB_CORBA::ProductCatalogue_i::getAccounting ( CORBA::Boolean  noWait  )  throw (CORBA::SystemException) [virtual]

Gets a reference to an accounting interface.

An accounting interface provide functions to retrieve tax keys, accounts, currency book, units, roundrules and chargetraits.

Returns:
Accounting interface.

virtual PpType_ptr OSB_CORBA::ProductCatalogue_i::getPpType ( const PpTypeId &  id  )  throw (CORBA::SystemException, OsbCorbaException) [virtual]

virtual PpTypeSeq* OSB_CORBA::ProductCatalogue_i::getPpTypes (  )  throw (CORBA::SystemException) [virtual]

virtual Pricelist_ptr OSB_CORBA::ProductCatalogue_i::getPricelist ( const PricelistId &  id  )  throw (CORBA::SystemException, OsbCorbaException) [virtual]

Gets a pricelist by its id.

Parameters:
id The id of the pricelist.
Returns:
The pricelist with the corresponding id.
Exceptions:
OsbCorbaException 
  • in case the pricelist referenced by this id cannot be found in the product catalogue

virtual ::corba::pcat::pl::PricelistCfg_ptr OSB_CORBA::ProductCatalogue_i::getPricelistCfg ( const corba::pcat::pl::PricelistId &  id  )  throw (CORBA::SystemException, OsbCorbaException)

Gets a pricelistCfg by providing pricelist id.

Parameters:
id The id of the pricelist.
Returns:
pricelistCfg corresponding to given pricelist id
Exceptions:
OsbCorbaException 
  • in case the pricelist id is not available.

PricelistCfg_ptr OSB_CORBA::ProductCatalogue_i::getPricelistCfgServant ( const OSB_LIB::PricelistCfg::Oid plCfgOid  )  throw (CORBA::SystemException) [private]

virtual PricelistSeq* OSB_CORBA::ProductCatalogue_i::getPricelists (  )  throw (CORBA::SystemException, OsbCorbaException) [virtual]

Get a list of all pricelists available in the product catalogue.

Returns:
The list of pricelists available in the product catalogue.
Exceptions:
OsbCorbaException 
  • in case locking of pricelists in product catalogue fails.

Pricelist_ptr OSB_CORBA::ProductCatalogue_i::getPricelistServant ( const OSB_LIB::Pricelist::Oid plOid  )  throw (CORBA::SystemException) [private]

virtual Product_ptr OSB_CORBA::ProductCatalogue_i::getProduct ( const ProductId &  id  )  throw (CORBA::SystemException, OsbCorbaException) [virtual]

virtual ProductSeq* OSB_CORBA::ProductCatalogue_i::getProducts (  )  throw (CORBA::SystemException) [virtual]

virtual ServerInfo* OSB_CORBA::ProductCatalogue_i::getServerInfo (  )  throw (CORBA::SystemException) [virtual]

Get corba server information.

Current information includes

  1. The naming service hostname that the corba server uses.
  2. The naming service port number that the corba server uses.
  3. The path where the log file of the corba server is stored.
  4. The database name.
  5. The database in use.
  6. User name who is logged in to the database.
  7. The CVS tag name of the server.

virtual ServiceElement OSB_CORBA::ProductCatalogue_i::getServiceElement ( const ServiceElementId &  seId  )  throw (CORBA::SystemException, OsbCorbaException) [virtual]

Get a service element.

Parameters:
seId Unique id of a service element.
Exceptions:
OsbCorbaException if the service element for seId does not exist in the tariff catalogue.
Returns:
Pointer to the service element for seId.

virtual ServiceElementSeq* OSB_CORBA::ProductCatalogue_i::getServiceElements (  )  throw (CORBA::SystemException) [virtual]

Get list of tariff systems from the tariff catalogue.

virtual TariffSystem* OSB_CORBA::ProductCatalogue_i::getTariffSystem ( const TariffSystemId &  tsId  )  throw (CORBA::SystemException, OsbCorbaException) [virtual]

Get a tariff system.

Parameters:
tsId Unique id of a tariff system.
Exceptions:
OsbCorbaException if the tariff system for tsId does not exist in the tariff catalogue.
Returns:
Pointer to the tariff system for tsId.

virtual TariffSystemSeq* OSB_CORBA::ProductCatalogue_i::getTariffSystems (  )  throw (CORBA::SystemException) [virtual]

Get list of tariff systems from the tariff catalogue.

template<typename T>
std::string OSB_CORBA::ProductCatalogue_i::idToStr ( const OSB_LIB::Id2< T > &  id  )  [inline, private]

Definition at line 454 of file productcatalogue_i.h.

template<typename T>
std::string OSB_CORBA::ProductCatalogue_i::idToStr ( const OSB_LIB::Id< T > &  id  )  [inline, private]

Definition at line 446 of file productcatalogue_i.h.

PortableServer::ObjectId_var OSB_CORBA::ProductCatalogue_i::objectId ( long  id  )  const

Locators& OSB_CORBA::ProductCatalogue_i::ppLocator (  )  [inline]

Definition at line 143 of file productcatalogue_i.h.

References ppLocator_.

virtual CORBA::Boolean OSB_CORBA::ProductCatalogue_i::releasePricelistCfg ( const PricelistId &  pricelistId,
CORBA::Boolean  noWait 
) throw (CORBA::SystemException, OsbCorbaException) [virtual]

Change status of a price list configuration from standby to released.

Parameters:
pricelistId The id of the pricelist
noWait Set to false if waiting is desired when lock is already acquired by others. If waiting is not desired, set flag to true.
Returns:
True if the pricelist configuration status was changed successfully.
Exceptions:
OsbCorbaException 
  • in case the database error occurs.

virtual CORBA::Boolean OSB_CORBA::ProductCatalogue_i::revokePricelistCfg ( const PricelistId &  pricelistId,
CORBA::Boolean  noWait 
) throw (CORBA::SystemException, OsbCorbaException) [virtual]

Change status of a price list configuration from released to standby.

Parameters:
pricelistId The id of the pricelist
noWait Set to false if waiting is desired when lock is already acquired by others. If waiting is not desired, set flag to true.
Returns:
True if the pricelist configuration status was changed successfully.
Exceptions:
OsbCorbaException 
  • in case the database error occurs.

virtual CORBA::Boolean OSB_CORBA::ProductCatalogue_i::unfreezePricelistCfg ( const PricelistId &  pricelistId,
CORBA::Boolean  noWait 
) throw (CORBA::SystemException, OsbCorbaException) [virtual]

Change status of a price list configuration from standby to editable.

Parameters:
pricelistId The id of the pricelist
noWait Set to false if waiting is desired when lock is already acquired by others. If waiting is not desired, set flag to true.
Returns:
True if the pricelist configuration status was changed successfully.
Exceptions:
OsbCorbaException 
  • in case the database error occurs.

PortableServer::POA_ptr OSB_CORBA::ProductCatalogue_i::writerPoa (  )  [inline]

Definition at line 138 of file productcatalogue_i.h.

References writerPoa_.


Member Data Documentation

PortableServer::POA_var OSB_CORBA::ProductCatalogue_i::accPoa_ [private]

Definition at line 411 of file productcatalogue_i.h.

const std::string OSB_CORBA::ProductCatalogue_i::IFC [static]

Definition at line 88 of file productcatalogue_i.h.

ServerInfo OSB_CORBA::ProductCatalogue_i::info_ [private]

Product admin server info.

Definition at line 397 of file productcatalogue_i.h.

PortableServer::POA_var OSB_CORBA::ProductCatalogue_i::pdPoa_ [private]

Definition at line 399 of file productcatalogue_i.h.

Locators OSB_CORBA::ProductCatalogue_i::plLocator_ [private]

Pricelist Servant Locator.

Definition at line 414 of file productcatalogue_i.h.

PortableServer::POA_var OSB_CORBA::ProductCatalogue_i::plPoa_ [private]

POA for pricelist.

Definition at line 408 of file productcatalogue_i.h.

Locators OSB_CORBA::ProductCatalogue_i::ppLocator_ [private]

Definition at line 405 of file productcatalogue_i.h.

Referenced by ppLocator().

PortableServer::POA_var OSB_CORBA::ProductCatalogue_i::ppPoa_ [private]

Definition at line 400 of file productcatalogue_i.h.

PortableServer::POA_var OSB_CORBA::ProductCatalogue_i::pptPoa_ [private]

Definition at line 401 of file productcatalogue_i.h.

PortableServer::POA_var OSB_CORBA::ProductCatalogue_i::writerPoa_ [private]

Definition at line 404 of file productcatalogue_i.h.

Referenced by writerPoa().


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