corba::pcat::pd::ProductWriter Interface Reference

Inheritance diagram for corba::pcat::pd::ProductWriter:

[legend]Collaboration diagram for corba::pcat::pd::ProductWriter:

[legend]List of all members.

---

Detailed Description

Give writer access to product writer interface.

Definition at line 129 of file product.idl.

Public Member Functions

• void setName (in common::Utf8String name) raises (common::OsbCorbaException)

  Set the name of a product.
  

• void setDesc (in common::Utf8String desc) raises (common::OsbCorbaException)

  Set the description of a product.
  

• void setStartDate (in common::Date start) raises (common::OsbCorbaException)

  Set the start release date for the product.
  

• void setEndDate (in common::Date end) raises (common::OsbCorbaException)

  Set the end release date for the product.
  

• pp::ProductPartWriter getWritablePart (in pp::ProductPartId id) raises (common::OsbCorbaException)

  Get a product part writer instance by its id.
  

• pp::ProductPartWriter addPart (in pp::PpTypeId pptypeid) raises (common::OsbCorbaException)

  Add a product part to the product.
  

• void removePart (in pp::ProductPartId id) raises (common::OsbCorbaException)

  Remove a product part from this product.
  

• void commitChanges () raises (common::OsbCorbaException)

  Commits all changes to the product.
  

---

Member Function Documentation

pp::ProductPartWriter corba::pcat::pd::ProductWriter::addPart

(

in pp::PpTypeId

pptypeid

)

raises (common::OsbCorbaException)

Add a product part to the product.

This method creates a new product part writer instance. The writer can be used to change the coresponding product part attributes.

The newly added product part has default values as described for pp::ProductPartWriter::addPart. The parent id is 0 which means the product part is the first generation of root product

Parameters:

pptypeid

The id of type for the product part.

Exceptions:

OsbCorbaException

invalid, unsupported product part type.

Returns:

The new product part's writer object used to be change the product part attributes.

void corba::pcat::pd::ProductWriter::commitChanges

(

)

raises (common::OsbCorbaException)

Commits all changes to the product.

The changes include adding a product part, removing a product part, changing any product part's attribute and the product attribute.

Any changes to the product and product part tree will be commited.

The product writer is destroyed if the function succeeds or if the product was modified by another user since the product writer was created.

In case of product configuration errors the writer object is not destroyed. This allows to correct the errors and to call the function again.

Exceptions:

OsbCorbaException

if the product is not consistent, i.e. it contains configuration errors. the product was modified by another user. The product writer is destroyed in this situation.

pp::ProductPartWriter corba::pcat::pd::ProductWriter::getWritablePart

(

in pp::ProductPartId

id

)

raises (common::OsbCorbaException)

Get a product part writer instance by its id.

The product part writer are used to change the coresponding product part attributes.

Parameters:

id

The id of the product part which should be found, owned to the product's part tree.

Exceptions:

OsbCorbaException

the product part not found in the product's part tree any other internal error while reading the descendants in the product.

Returns:

The corresponding product part writer object.

void corba::pcat::pd::ProductWriter::removePart

(

in pp::ProductPartId

id

)

raises (common::OsbCorbaException)

Remove a product part from this product.

Parameters:

id

The id of the product part to be removed from list of product parts for this product.

Exceptions:

OsbCorbaException

product part not found.

void corba::pcat::pd::ProductWriter::setDesc

(

in common::Utf8String

desc

)

raises (common::OsbCorbaException)

Set the description of a product.

This method sets the new description of a product.

Parameters:

desc

The new description of the product.

Exceptions:

OsbException

if the status is not editable.

void corba::pcat::pd::ProductWriter::setEndDate

(

in common::Date

end

)

raises (common::OsbCorbaException)

Set the end release date for the product.

Parameters:

end

Ending date of release mode.

Exceptions:

OsbException

if end date is earlier than start date or today.

void corba::pcat::pd::ProductWriter::setName

(

in common::Utf8String

name

)

raises (common::OsbCorbaException)

Set the name of a product.

This method sets the new name of a product.

Parameters:

name

The new name of the product.

Exceptions:

OsbException

if the status is not editable.

void corba::pcat::pd::ProductWriter::setStartDate

(

in common::Date

start

)

raises (common::OsbCorbaException)

Set the start release date for the product.

Parameters:

start

Starting date of release mode.

Exceptions:

OsbException

if end date is earlier than start date status is not editable or standby.

---

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

• product.idl

---