corba::pcat::ProductCatalogue Interface Reference

Collaboration diagram for corba::pcat::ProductCatalogue:

Detailed Description

Object factory for all product related classes.

The product catalogue is the object factory for all product related classes:

ToDo: A product catalogue writer interface has to be added or the POA settings for the product catalogue have to be made such that no two users can simultanously call a get and an update method.

Definition at line 61 of file productcatalogue.idl.

Public Member Functions

pp::PpTypeSeq getPpTypes ()
Get a list of product part type.
pp::PpType getPpType (in pp::PpTypeId id) raises (common::OsbCorbaException)
Get a product part type by id.
common::Accounting getAccounting (in boolean noWait)
Gets a reference to an accounting interface.
boolean creChargeTraits (in common::CurrencyCode currency, in common::RoundRuleId rrId, in common::Utf8String accCode, in common::Utf8String numFormat, in common::TaxKeyId tkId, in common::ChargeType cType, in boolean noWait, out common::ChargeTraits chrgTraits) raises (common::OsbCorbaException)
Create charge traits.

Handling of products

pd::Product getProduct (in pd::ProductId id) raises (common::OsbCorbaException)
Gets a product by its id.
pd::ProductSeq getProducts ()
Get a list of all products in the product catalogue.
pd::ProductWriter creProduct () raises (common::OsbCorbaException)
Create a product.
void delProduct (in pd::ProductId id) raises (common::OsbCorbaException)
Deletes an existing product.

Handling of pricelists.

pl::Pricelist getPricelist (in pl::PricelistId id) raises (common::OsbCorbaException)
Gets a pricelist by its id.
pl::PricelistSeq getPricelists () raises (common::OsbCorbaException)
Get a list of all pricelists available in the product catalogue.
pl::PricelistWriter crePricelist ()
Create a pricelist.
void delPricelist (in pl::PricelistId id, in boolean noWait) raises (common::OsbCorbaException)
Deletes an existing pricelist.
pl::PricelistCfg getPricelistCfg (in pl::PricelistId id) raises (common::OsbCorbaException)
Gets a pricelistCfg by providing pricelist id.

Status changes on PricelistCfg.

boolean checkPricelistCfg (in pl::PricelistId pricelistId, in boolean noWait) raises (common::OsbCorbaException)
Change status of a price list configuration from editable to standby.
boolean releasePricelistCfg (in pl::PricelistId pricelistId, in boolean noWait) raises (common::OsbCorbaException)
Change status of a price list configuration from standby to released.
boolean revokePricelistCfg (in pl::PricelistId pricelistId, in boolean noWait) raises (common::OsbCorbaException)
Change status of a price list configuration from released to standby.
boolean unfreezePricelistCfg (in pl::PricelistId pricelistId, in boolean noWait) raises (common::OsbCorbaException)
Change status of a price list configuration from standby to editable.

Service elements:

service::ServiceElement getServiceElement (in service::ServiceElementId seId) raises (common::OsbCorbaException)
Get a service element by its id.
service::ServiceElementSeq getServiceElements ()
Get list of service elements from the tariff catalogue.

Tariff systems:

tcat::ts::TariffSystem getTariffSystem (in tcat::ts::TariffSystemId tsId) raises (common::OsbCorbaException)
Get a tariff system by its id.
tcat::ts::TariffSystemSeq getTariffSystems ()
Get list of tariff systems from the tariff catalogue.

Public Attributes

readonly attribute common::ServerInfo getServerInfo
Get CORBA server information.

Member Function Documentation

boolean corba::pcat::ProductCatalogue::checkPricelistCfg	(	in pl::PricelistId	pricelistId,
		in boolean	noWait
	)			raises (common::OsbCorbaException)

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.

boolean corba::pcat::ProductCatalogue::creChargeTraits	(	in common::CurrencyCode	currency,
		in common::RoundRuleId	rrId,
		in common::Utf8String	accCode,
		in common::Utf8String	numFormat,
		in common::TaxKeyId	tkId,
		in common::ChargeType	cType,
		in boolean	noWait,
		out common::ChargeTraits	chrgTraits
	)			raises (common::OsbCorbaException)

Create charge traits.

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 round rule.
	accCode	Account code.
	numFormat	Number format.
	tkId	Unique id of tax key.
	cType	Charge type.
	noWait	Set to true if waiting is desired when lock is already acquired by others. If waiting is not desired, set flag to true.
	chrgTraits	Charge traits struct contains either an existing charge traits or a newly created charge traits.

Returns:: True if a new charge traits is created else return false if an existing one is found.

Exceptions:

OsbCorbaException

in case the charge traits type is configured
if anyother database error occurs.

pl::PricelistWriter corba::pcat::ProductCatalogue::crePricelist ( )

Create a pricelist.

Returns:: The newly created, writeable pricelist.

Remarks:: The pricelist is saved permanently only after pd::PricelistWriter::commitChanges is called successfully.

pd::ProductWriter corba::pcat::ProductCatalogue::creProduct ( ) raises (common::OsbCorbaException)

Create a product.

Exceptions:

OsbCorbaException

in case the product cannot be created.
any other internal error while creating the product.

Returns:: The newly created, writeable product.

Remarks:: The product is saved permanently only after pd::ProductWriter::commitChanges is called successfully.

ToDo: The current implementation calls `createProduct' of the library product catalogue => the product IS created in the database. Either correct the implementation of the servant OR this documentation.

void corba::pcat::ProductCatalogue::delPricelist	(	in pl::PricelistId	id,
		in boolean	noWait
	)			raises (common::OsbCorbaException)

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.

void corba::pcat::ProductCatalogue::delProduct ( in pd::ProductId id ) raises (common::OsbCorbaException)

Deletes an existing product.

Parameters:

Id of the product to delete.

Exceptions:

OsbCorbaException

if the product does not exist
any other internal error while deleting the product from the product catalogue.

common::Accounting corba::pcat::ProductCatalogue::getAccounting ( in boolean noWait )

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.

pp::PpType corba::pcat::ProductCatalogue::getPpType ( in pp::PpTypeId id ) raises (common::OsbCorbaException)

Get a product part type by id.

Parameters:

Id of the product part type.

Exceptions:

OsbCorbaException

if the id is invalid.

pp::PpTypeSeq corba::pcat::ProductCatalogue::getPpTypes ( )

Get a list of product part type.

pl::Pricelist corba::pcat::ProductCatalogue::getPricelist ( in pl::PricelistId id ) raises (common::OsbCorbaException)

Gets a pricelist by its id.

Parameters:

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

pl::PricelistCfg corba::pcat::ProductCatalogue::getPricelistCfg ( in pl::PricelistId id ) raises (common::OsbCorbaException)

Gets a pricelistCfg by providing pricelist id.

Parameters:

The id of the pricelist.

Returns:: pricelistCfg corresponding to given pricelist id

Exceptions:

OsbCorbaException

in case the pricelist id is not available.

pl::PricelistSeq corba::pcat::ProductCatalogue::getPricelists ( ) raises (common::OsbCorbaException)

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

Returns:: The list of pricelists available in the product catalogue.

pd::Product corba::pcat::ProductCatalogue::getProduct ( in pd::ProductId id ) raises (common::OsbCorbaException)

Gets a product by its id.

Parameters:

The id of the product.

Returns:: The product with the corresponding id.

Exceptions:

OsbCorbaException

in case the product referenced by this id cannot be found in the product catalogue
any other internal error while reading the product from the product catalalogue.

pd::ProductSeq corba::pcat::ProductCatalogue::getProducts ( )

Get a list of all products in the product catalogue.

Returns:: The list of products currently held in the product catalogue.

service::ServiceElement corba::pcat::ProductCatalogue::getServiceElement ( in service::ServiceElementId seId ) raises (common::OsbCorbaException)

Get a service element by its id.

Parameters:

seId

Unqiue id of service element.

Exceptions:

OsbCorbaException

if the service element does not exist in the tariff catalogue.

Returns:: The service element for seId.

service::ServiceElementSeq corba::pcat::ProductCatalogue::getServiceElements ( )

Get list of service elements from the tariff catalogue.

tcat::ts::TariffSystem corba::pcat::ProductCatalogue::getTariffSystem ( in tcat::ts::TariffSystemId tsId ) raises (common::OsbCorbaException)

Get a tariff system by its id.

Parameters:

tsId

Unqiue id of tariff system.

Exceptions:

OsbCorbaException

if the tariff system does not exist the tariff catalogue.

Returns:: The tariff system for cpId.

tcat::ts::TariffSystemSeq corba::pcat::ProductCatalogue::getTariffSystems ( )

Get list of tariff systems from the tariff catalogue.

boolean corba::pcat::ProductCatalogue::releasePricelistCfg	(	in pl::PricelistId	pricelistId,
		in boolean	noWait
	)			raises (common::OsbCorbaException)

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.

boolean corba::pcat::ProductCatalogue::revokePricelistCfg	(	in pl::PricelistId	pricelistId,
		in boolean	noWait
	)			raises (common::OsbCorbaException)

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.

boolean corba::pcat::ProductCatalogue::unfreezePricelistCfg	(	in pl::PricelistId	pricelistId,
		in boolean	noWait
	)			raises (common::OsbCorbaException)

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.

Member Data Documentation

readonly attribute common::ServerInfo corba::pcat::ProductCatalogue::getServerInfo

Get CORBA server information.

Definition at line 63 of file productcatalogue.idl.

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

productcatalogue.idl

Generated on Sat Sep 2 14:24:56 2006 for OSB Library by

1.4.7