corba::pcat::pp::TsPartWriter Interface Reference
Inheritance diagram for corba::pcat::pp::TsPartWriter:
[legend]Collaboration diagram for corba::pcat::pp::TsPartWriter:
[legend]List of all members.
Detailed Description
Writable interface for a tariff system part.
Configuration of a tariff system part can only be made through this writable interface. Tariff systems may be added/removed to/from the list of tariff systems. One of the tariff systems may be chosen as the default for personalization.
The TsPartWriter uses the mutator mehtods of the OSB_LIB::TariffSystemItem.
Definition at line 93 of file tspart.idl.
Public Member Functions
- boolean addTs (in TariffSystemId tsId)
- Adds a tariff system to the list of available tariff systems.
- boolean rmTs (in TariffSystemId tsId)
- Removes a tariff system from the list of available tariff systems.
- void clear ()
- Delete all tariff systems from the list and clear the default tariff system.
- void setDefaultTs (in TariffSystemId tsId)
- Sets a tariff system as the default tariff system.
- void clearDefaultTs ()
- Clears the default tariff system.
Member Function Documentation
| boolean corba::pcat::pp::TsPartWriter::addTs |
( |
in TariffSystemId |
tsId |
) |
|
Adds a tariff system to the list of available tariff systems.
- Parameters:
-
| tsId | Id of tariff system to add. |
- Returns:
- True if tsId was not already in the list of tariff systems, false otherwise.
- Remarks:
- The method does not verify that the tariff system already exists.
| void corba::pcat::pp::TsPartWriter::clear |
( |
|
) |
|
Delete all tariff systems from the list and clear the default tariff system.
| void corba::pcat::pp::TsPartWriter::clearDefaultTs |
( |
|
) |
|
Clears the default tariff system.
- Remarks:
- The tariff system is not removed from the list.
| boolean corba::pcat::pp::TsPartWriter::rmTs |
( |
in TariffSystemId |
tsId |
) |
|
Removes a tariff system from the list of available tariff systems.
- Parameters:
-
| tsId | Id of tariff system to remove. |
- Returns:
- True if tsId was in the list of tariff systems, false otherwise.
- Remarks:
- If the tariff system to remove is the default tariff system, the default tariff system is cleared.
| void corba::pcat::pp::TsPartWriter::setDefaultTs |
( |
in TariffSystemId |
tsId |
) |
|
Sets a tariff system as the default tariff system.
- Parameters:
-
| tsId | Id of the new default tariff system. |
- Remarks:
- If the tsId does not exist in the list of tariff systems, it is automatically added to the list.
The documentation for this interface was generated from the following file:
Generated on Sat Sep 2 14:25:25 2006 for OSB Library by
1.4.7