OSB_CORBA::ProductPartBase_i Class Reference

Inheritance diagram for OSB_CORBA::ProductPartBase_i:

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

Collaboration graph
[legend]
List of all members.

Detailed Description

Servant for ProductPart.

This base class implements all methods of ProductPart as defined in the IDL. It uses read guards, issued by the derived class, to access the OSB library object (node or item). The locking of these objects is different for read-only and writable parts. In the 1st case, the product nodes and items are managed by the product catalogue and the locks must be aquired from the lock manager. Writable product parts are owner of the underlaying product node and item, they are private between the CORBA server and client: no locking is required.

Definition at line 92 of file productpart_i.h.

Public Member Functions

Protected Types

Protected Member Functions


Member Typedef Documentation

typedef OSB_LIB::ProductItem::Oid OSB_CORBA::ProductPartBase_i::ItemOid [protected]

Shorthand for an OSB libary product item id.

Definition at line 156 of file productpart_i.h.

typedef OSB_LIB::ProductNode::Oid OSB_CORBA::ProductPartBase_i::NodeOid [protected]

Shorthand for an OSB libary product node id.

Definition at line 154 of file productpart_i.h.

typedef OSB_LIB::PcatLockMgr::ProductNodeRg OSB_CORBA::ProductPartBase_i::NodeRg [protected]

Shorthand for a product node read guard.

Definition at line 170 of file productpart_i.h.

typedef OSB_LIB::Product::Oid OSB_CORBA::ProductPartBase_i::ProductOid [protected]

Shorthand for an OSB libary product id.

Definition at line 152 of file productpart_i.h.


Member Function Documentation

virtual PpCfgPersType OSB_CORBA::ProductPartBase_i::canPersonalize (  )  throw (OsbCorbaException) [virtual]

Flag to indicate if personalization is allowed.

virtual PpCfgType OSB_CORBA::ProductPartBase_i::cfgType (  )  throw (OsbCorbaException) [virtual]

Config type of the product part.

virtual Utf8String* OSB_CORBA::ProductPartBase_i::configDes (  )  throw (OsbCorbaException) [virtual]

Config description of the product part.

virtual Utf8String* OSB_CORBA::ProductPartBase_i::defPersDes (  )  throw (OsbCorbaException) [virtual]

Default Personalization description of the product part.

virtual PpDefPersType OSB_CORBA::ProductPartBase_i::defPersType (  )  throw (OsbCorbaException) [virtual]

Default personalization type of the product part.

virtual Utf8String* OSB_CORBA::ProductPartBase_i::desc (  )  throw (OsbCorbaException) [virtual]

Description of the product part.

const OSB_LIB::ProductItem* OSB_CORBA::ProductPartBase_i::getItem ( const NodeRg guard,
const std::string &  ifc,
const std::string &  module 
) const throw (OsbCorbaException) [protected]

Get a product item pointer.

This method calls getNode() and tries to retrieve the product item owned by the returned node. If the item is 0, an exception is thrown.

Remarks:
This method is protected because it is used in the concrete readable parts.

const OSB_LIB::ProductNode* OSB_CORBA::ProductPartBase_i::getNode ( const NodeRg guard,
const std::string &  ifc,
const std::string &  module 
) const throw (OsbCorbaException) [protected]

Get a product node pointer.

This method checks if the guard parameter contains a pointer to the product node. If it does, the pointer is returned. If it does not, an exception is thrown.

virtual ProductPartSeq* OSB_CORBA::ProductPartBase_i::getParts (  )  throw (OsbCorbaException) [virtual]

Get the product part's children.

virtual ProductPartId OSB_CORBA::ProductPartBase_i::id (  )  throw (OsbCorbaException) [virtual]

Id of the product part.

virtual const std::string& OSB_CORBA::ProductPartBase_i::ifc (  )  const [protected, pure virtual]

String representation of the concrete interface.

Implemented in OSB_CORBA::DevicePart_i, OSB_CORBA::DevicePartWriter_i, OSB_CORBA::E164Part_i, OSB_CORBA::E164PartWriter_i, OSB_CORBA::PlPart_i, OSB_CORBA::PlPartWriter_i, OSB_CORBA::DescPart_i, OSB_CORBA::DescPartWriter_i, OSB_CORBA::AnPart_i, OSB_CORBA::AnPartWriter_i, OSB_CORBA::IpGroupPart_i, OSB_CORBA::IpGroupPartWriter_i, OSB_CORBA::TrunkPart_i, OSB_CORBA::TrunkPartWriter_i, OSB_CORBA::ServicePart_i, OSB_CORBA::ServicePartWriter_i, OSB_CORBA::TsPart_i, and OSB_CORBA::TsPartWriter_i.

virtual ItemOid OSB_CORBA::ProductPartBase_i::itemId (  )  const [pure virtual]

Get the OSB library product item id.

Implemented in OSB_CORBA::ProductPart_i, and OSB_CORBA::ProductPartWriter_i.

virtual NodeRg OSB_CORBA::ProductPartBase_i::lockNode (  )  const [protected, pure virtual]

Protected read access to the part's product node.

Returns:
A readguard containing the OSB library product node.

Implemented in OSB_CORBA::ProductPart_i, and OSB_CORBA::ProductPartWriter_i.

virtual CORBA::Long OSB_CORBA::ProductPartBase_i::mandatory (  )  throw (OsbCorbaException) [virtual]

Mandatory setting of the product part.

virtual Utf8String* OSB_CORBA::ProductPartBase_i::name (  )  throw (OsbCorbaException) [virtual]

Name of the product part.

virtual NodeOid OSB_CORBA::ProductPartBase_i::nodeId (  )  const [pure virtual]

Get the OSB library product node id.

Implemented in OSB_CORBA::ProductPart_i, and OSB_CORBA::ProductPartWriter_i.

virtual ProductPartId OSB_CORBA::ProductPartBase_i::parentId (  )  throw (OsbCorbaException) [virtual]

Parent id of the product part.

Remarks:
The id is not set if the part is a first generation part of the product.

ProductOid OSB_CORBA::ProductPartBase_i::prodId (  )  const

Get the OSB library product id.

virtual const Product_i& OSB_CORBA::ProductPartBase_i::productServant (  )  const [protected, pure virtual]

Provide const access to the controlling product servant.

Implemented in OSB_CORBA::ProductPart_i, and OSB_CORBA::ProductPartWriter_i.

virtual Product_i& OSB_CORBA::ProductPartBase_i::productServant (  )  [protected, pure virtual]

Provide access to the controlling product servant.

Implemented in OSB_CORBA::ProductPart_i, and OSB_CORBA::ProductPartWriter_i.

virtual PpTypeId OSB_CORBA::ProductPartBase_i::tid (  )  throw (OsbCorbaException) [virtual]

Type of the product part.


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