corba::common::Accounting Interface Reference

List of all members.

---

Detailed Description

This interface provides functions to retrieve chargetraits, taxkeys, accounts, roundrules, currencybook and units.

User of this interface at the server side has to create an Accounting servant in order to use the retrieval functions provided in the interface.

Definition at line 267 of file chargetraits.idl.

Public Member Functions

• ChargeTraits getChargeTraits (in ChargeTraitsId id) raises (OsbCorbaException)

  Gets a charge traits by its Id.
  

• ChargeTraitsSeq getChargeTraitses () raises (OsbCorbaException)

  Get chargetraits list.
  

• Account getAccount (in Utf8String accCode) raises (OsbCorbaException)

  Gets an account by its Id.
  

• AccountSeq getAccounts () raises (OsbCorbaException)

  Get list of account.
  

• Currency getCurrency (in CurrencyCode code) raises (OsbCorbaException)

  Retrieve a currency by its code.
  

• CurrencyBook getCurrencyBook () raises (OsbCorbaException)

  Retrieves list of currency.
  

• RoundRuleId getRoundRuleByName (in Utf8String name) raises (OsbCorbaException)

  Retrieves a roundrule by its name.
  

• RoundRule getRoundRule (in RoundRuleId id) raises (OsbCorbaException)

  Retrieves a round rule by its Id.
  

• RoundRuleSeq getRoundRules () raises (OsbCorbaException)

  Retrieves list of round rule.
  

• TaxKeyId getTaxKeyByName (in Utf8String name) raises (OsbCorbaException)

  Retrieves a tax key by its name.
  

• TaxKey getTaxKey (in TaxKeyId id) raises (OsbCorbaException)

  Retrieves a tax key by its Id.
  

• TaxKeySeq getTaxKeys () raises (OsbCorbaException)

  Retrieves list of tax key.
  

• TaxKeySeq getAssocTaxKeys () raises (OsbCorbaException)

  Get list of associate tax keys.
  

• TaxKeySeq getContractTaxKeys () raises (OsbCorbaException)

  Get list of contract tax keys.
  

• corba::common::TaxKeySeq getProductTaxKeys () raises (corba::common::OsbCorbaException)

  Get list of product tax keys.
  

• UnitId getUnitByName (in Utf8String name) raises (OsbCorbaException)

  Retrieves an unit by its name.
  

• Unit getUnit (in UnitId id) raises (OsbCorbaException)

  Gets a unit by its id.
  

• UnitSeq getUnits () raises (OsbCorbaException)

  Get list of units.
  

---

Member Function Documentation

Account corba::common::Accounting::getAccount

(

in Utf8String

accCode

)

raises (OsbCorbaException)

Gets an account by its Id.

Parameters:

accCode

The code of the account which should be found.

Returns:

Account struct.

Exceptions:

OsbCorbaException

In case the account referenced by this id cannot be found in the tariff catalogue.

AccountSeq corba::common::Accounting::getAccounts

(

)

raises (OsbCorbaException)

Get list of account.

TaxKeySeq corba::common::Accounting::getAssocTaxKeys

(

)

raises (OsbCorbaException)

Get list of associate tax keys.

ChargeTraits corba::common::Accounting::getChargeTraits

(

in ChargeTraitsId

id

)

raises (OsbCorbaException)

Gets a charge traits by its Id.

Parameters:

id

The id of the charge traits which should be found.

Returns:

Charge traits struct.

Exceptions:

OsbCorbaException

In case the charge traits referenced by this id cannot be found in the tariff catalogue.

ChargeTraitsSeq corba::common::Accounting::getChargeTraitses

(

)

raises (OsbCorbaException)

Get chargetraits list.

TaxKeySeq corba::common::Accounting::getContractTaxKeys

(

)

raises (OsbCorbaException)

Get list of contract tax keys.

Currency corba::common::Accounting::getCurrency

(

in CurrencyCode

code

)

raises (OsbCorbaException)

Retrieve a currency by its code.

Parameters:

code

The id of the currency which should be found.

Returns:

Currency struct.

Exceptions:

OsbCorbaException

In case the currency referenced by this id cannot be found in the tariff catalogue.

CurrencyBook corba::common::Accounting::getCurrencyBook

(

)

raises (OsbCorbaException)

Retrieves list of currency.

corba::common::TaxKeySeq corba::common::Accounting::getProductTaxKeys

(

)

raises (corba::common::OsbCorbaException)

Get list of product tax keys.

RoundRule corba::common::Accounting::getRoundRule

(

in RoundRuleId

id

)

raises (OsbCorbaException)

Retrieves a round rule by its Id.

Parameters:

id

The id of the round rule which should be found.

Returns:

Round rule struct.

Exceptions:

OsbCorbaException

In case the round rule referenced by this id cannot be found in the tariff catalogue.

RoundRuleId corba::common::Accounting::getRoundRuleByName

(

in Utf8String

name

)

raises (OsbCorbaException)

Retrieves a roundrule by its name.

Parameters:

name

The name of the round rule to search for.

Returns:

Round rule unique id if found else return ID_NOT_SET.

RoundRuleSeq corba::common::Accounting::getRoundRules

(

)

raises (OsbCorbaException)

Retrieves list of round rule.

TaxKey corba::common::Accounting::getTaxKey

(

in TaxKeyId

id

)

raises (OsbCorbaException)

Retrieves a tax key by its Id.

Parameters:

id

The id of the tax key which should be found.

Returns:

Tax key struct.

Exceptions:

OsbCorbaException

In case the tax key referenced by this id cannot be found in the tariff catalogue.

TaxKeyId corba::common::Accounting::getTaxKeyByName

(

in Utf8String

name

)

raises (OsbCorbaException)

Retrieves a tax key by its name.

Parameters:

name

The name of the tax key to search for.

Returns:

Tax key unique id if found else return ID_NOT_SET.

TaxKeySeq corba::common::Accounting::getTaxKeys

(

)

raises (OsbCorbaException)

Retrieves list of tax key.

Unit corba::common::Accounting::getUnit

(

in UnitId

id

)

raises (OsbCorbaException)

Gets a unit by its id.

Parameters:

id

The id of unit.

Returns:

Unit struct.

Exceptions:

OsbCorbaException

if unit referenced by this id cannot be found.

UnitId corba::common::Accounting::getUnitByName

(

in Utf8String

name

)

raises (OsbCorbaException)

Retrieves an unit by its name.

Parameters:

name

The name of the unit to search for.

Returns:

Unit unique id if found else return ID_NOT_SET.

UnitSeq corba::common::Accounting::getUnits

(

)

raises (OsbCorbaException)

Get list of units.

---

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

• chargetraits.idl

---