corba::pcat::pd::Product Interface Reference

Inheritance diagram for corba::pcat::pd::Product:

[legend]List of all members.

---

Detailed Description

Gives readonly access to the product.

This interface defines readonly access to the product and its product parts.

Definition at line 60 of file product.idl.

Public Member Functions

• ProductId id () raises (common::OsbCorbaException)

  The unique id of the product.
  

• common::Utf8String name () raises (common::OsbCorbaException)

  The name of the product.
  

• common::Utf8String desc () raises (common::OsbCorbaException)

  The description of the product.
  

• common::CfgStatus status () raises (common::OsbCorbaException)

  The status of the product.
  

• common::Date startDate () raises (common::OsbCorbaException)

  The start date of status released.
  

• common::Date endDate () raises (common::OsbCorbaException)

  The end date of status released.
  

• pp::ProductPart getPart (in pp::ProductPartId id) raises (common::OsbCorbaException)

  Get a product part by id.
  

• pp::ProductPartSeq getParts ()

  Get the first generation product parts of this product.
  

• ProductWriter getWriter ()

  Get a product writer instance for this product.
  

---

Member Function Documentation

common::Utf8String corba::pcat::pd::Product::desc

(

)

raises (common::OsbCorbaException)

The description of the product.

common::Date corba::pcat::pd::Product::endDate

(

)

raises (common::OsbCorbaException)

The end date of status released.

pp::ProductPart corba::pcat::pd::Product::getPart

(

in pp::ProductPartId

id

)

raises (common::OsbCorbaException)

Get a product part by id.

Parameters:

id

The id of the product part.

Exceptions:

OsbCorbaException

in case the product part cannot be found in the first generation product parts of this product.

Returns:

The product part instance.

pp::ProductPartSeq corba::pcat::pd::Product::getParts

(

)

Get the first generation product parts of this product.

Returns:

A list of the product's first generation parts.

ProductWriter corba::pcat::pd::Product::getWriter

(

)

Get a product writer instance for this product.

This method returns a product writer instance for the corresponding product. A product writer is needed whenever a product or it's product part tree shall be modified. Therefore the product writer interface offers functionality for modifying the attributes of a product and the product part tree.

Returns:

The corresponding product writer object.

ProductId corba::pcat::pd::Product::id

(

)

raises (common::OsbCorbaException)

The unique id of the product.

The id of the product cannot be changed once created.

common::Utf8String corba::pcat::pd::Product::name

(

)

raises (common::OsbCorbaException)

The name of the product.

common::Date corba::pcat::pd::Product::startDate

(

)

raises (common::OsbCorbaException)

The start date of status released.

common::CfgStatus corba::pcat::pd::Product::status

(

)

raises (common::OsbCorbaException)

The status of the product.

---

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

• product.idl

---