corba::cadmin::ContractAdmin Interface Reference

Collaboration diagram for corba::cadmin::ContractAdmin:

[legend]List of all members.

---

Detailed Description

Interface provides search functionalities and functions to retrieve an accounting interface, address types, bill cycles and status reasons.

Definition at line 118 of file contractadmin.idl.

Public Member Functions

• AnCList getAnCList () raises (common::OsbCorbaException)

  Get a reference to an empty AnCList.
  

• common::Accounting getAccounting (in boolean noWait) raises (common::OsbCorbaException)

  Get an accounting interface.
  

• ProductSeq getProducts ()

  Get list of products.
  

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

  Get a product.
  

• ProductPart getProductPart (in pcat::pd::ProductId id, in pcat::pp::ProductPartId ppId) raises (common::OsbCorbaException)

  Get a product part.
  

• void refreshProductCatalogue (in boolean noWait) raises (common::OsbCorbaException)

  Refresh the product catalogue.
  

• void refreshTariffCatalogue (in boolean noWait) raises (common::OsbCorbaException)

  Refresh the tariff catalogue.
  

• cadmin::addr::AddressType getAddressType (in cadmin::addr::AddrTypeId id) raises (common::OsbCorbaException)

  Get an address based on address type.
  

• cadmin::addr::AddressTypeSeq getAddressTypes () raises (common::OsbCorbaException)

  Get list of address types supported.
  

• StatusReason getStatusReason (in StatusReasonId id) raises (common::OsbCorbaException)

  Get a status reason.
  

• StatusReasonSeq getStatusReasons () raises (common::OsbCorbaException)

  Get list of reasons for a status changed supported.
  

• cadmin::contract::BillCycle getBillCycle (in cadmin::BillCycleId id) raises (common::OsbCorbaException)

  Get a bill cycle.
  

• cadmin::contract::BillCycleSeq getBillCycles () raises (common::OsbCorbaException)

  Get list of bill cycles.
  

• 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.
  

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.
  

Status requests:

• StatusReqResult procStatusRequest (in cadmin::StatusRequestId srqId, out common::CfgErrorSeq errors) raises (common::OsbCorbaException)

  Process a status request.
  

• common::CfgErrorSeq delStatusRequest (in StatusRequestId srqId) raises (common::OsbCorbaException)

  Delete a status request.
  

Public Attributes

• readonly attribute common::ServerInfo getServerInfo

  Get CORBA server information.
  

---

Member Function Documentation

boolean corba::cadmin::ContractAdmin::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	Unique 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	Contain charge traits that is newly created or charge traits that already exist.

Returns:

True if new charge traits is created else return false.

Exceptions:

OsbCorbaException

if database error occurs.

common::CfgErrorSeq corba::cadmin::ContractAdmin::delStatusRequest

(

in StatusRequestId

srqId

)

raises (common::OsbCorbaException)

Delete a status request.

Parameters:

srqId

Status request to delete.

Returns:

Errors and warnings detected while deleting the status request.

Exceptions:

OsbCorbaException

for any exceptions.

common::Accounting corba::cadmin::ContractAdmin::getAccounting

(

in boolean

noWait

)

raises (common::OsbCorbaException)

Get an accounting interface.

cadmin::addr::AddressType corba::cadmin::ContractAdmin::getAddressType

(

in cadmin::addr::AddrTypeId

id

)

raises (common::OsbCorbaException)

Get an address based on address type.

cadmin::addr::AddressTypeSeq corba::cadmin::ContractAdmin::getAddressTypes

(

)

raises (common::OsbCorbaException)

Get list of address types supported.

AnCList corba::cadmin::ContractAdmin::getAnCList

(

)

raises (common::OsbCorbaException)

Get a reference to an empty AnCList.

Allows user to add a new associate to an empty AnCList.

cadmin::contract::BillCycle corba::cadmin::ContractAdmin::getBillCycle

(

in cadmin::BillCycleId

id

)

raises (common::OsbCorbaException)

Get a bill cycle.

cadmin::contract::BillCycleSeq corba::cadmin::ContractAdmin::getBillCycles

(

)

raises (common::OsbCorbaException)

Get list of bill cycles.

Product corba::cadmin::ContractAdmin::getProduct

(

in pcat::pd::ProductId

id

)

raises (common::OsbCorbaException)

Get a product.

ProductPart corba::cadmin::ContractAdmin::getProductPart	(	in pcat::pd::ProductId	id,
		in pcat::pp::ProductPartId	ppId
	)			raises (common::OsbCorbaException)

Get a product part.

ProductSeq corba::cadmin::ContractAdmin::getProducts

(

)

Get list of products.

StatusReason corba::cadmin::ContractAdmin::getStatusReason

(

in StatusReasonId

id

)

raises (common::OsbCorbaException)

Get a status reason.

StatusReasonSeq corba::cadmin::ContractAdmin::getStatusReasons

(

)

raises (common::OsbCorbaException)

Get list of reasons for a status changed supported.

tcat::ts::TariffSystem corba::cadmin::ContractAdmin::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 connection point for cpId.

tcat::ts::TariffSystemSeq corba::cadmin::ContractAdmin::getTariffSystems

(

)

Get list of tariff systems from the tariff catalogue.

StatusReqResult corba::cadmin::ContractAdmin::procStatusRequest	(	in cadmin::StatusRequestId	srqId,
		out common::CfgErrorSeq	errors
	)			raises (common::OsbCorbaException)

Process a status request.

Parameters:

	srqId	The id of the status request to process, the request itself must already be stored in the database.
	errors	Gets errors and warnings detected while processing the status request.

Returns:

The processing result.

Exceptions:

OsbCorbaException

for any exceptions.

void corba::cadmin::ContractAdmin::refreshProductCatalogue

(

in boolean

noWait

)

raises (common::OsbCorbaException)

Refresh the product catalogue.

void corba::cadmin::ContractAdmin::refreshTariffCatalogue

(

in boolean

noWait

)

raises (common::OsbCorbaException)

Refresh the tariff catalogue.

---

Member Data Documentation

readonly attribute common::ServerInfo corba::cadmin::ContractAdmin::getServerInfo

Get CORBA server information.

Definition at line 120 of file contractadmin.idl.

---

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

• contractadmin.idl

---