chargetraits.idl

Go to the documentation of this file.

// OSB library ********************************************* -*- C++ -*-
/*
  AUTHOR(S): Darryl Kang (dk)

  RCS information
   $Name: OSB_060808 $
   $Revision: 1.21.2.1 $

  License
   OSB rating and billing library for communication networks
   Copyright (C) 2004, 2005, 2006  OSB systems

   This file may be distributed and/or modify under the terms of the
   GNU General Public License (GPL) as published by the Free Software
   Foundation which is provided in the file LICENSE.GPL included in the
   packaging of this file.

   The file is distributed in the hope that it will be useful, but WITHOUT
   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
   FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
   for more details.

   Holders of a OSB Commercial License may use this file under the terms
   and conditions of this commercial license.
 */
#ifndef CHARGETRAITS_IDL
#define CHARGETRAITS_IDL
// *********************************************************************
#include "utf8string.idl"
#include "corba_utility.idl"

module corba {
    module common {
        enum ChargeType {
            ct_unknown,
            ct_gross,                 
            ct_net                    
        };

        enum AccountType {
            Assets,                   
            Liabilities,              
            Capital                   
        };

        enum RoundRuleType {
            rr_unknown,               
            rr_roundUp,               
            rr_dontRound              
        };

        enum TaxKeyType {
            tktUnknown,               
            tktAssociate,             
            tktContract,              
            tktProduct                
        };

        struct AccountId {
            long id;
        };

        struct UnitId {
            long id;
        };

        struct ChargeTraitsId {
            long id;
        };

        struct CurrencyCode {
            Utf8String id;
        };

        struct RoundRuleId {
            long id;
        };

        struct TaxKeyId {
            long id;
        };

        struct Unit {
            UnitId id;

            Utf8String name;
        };

        struct Account {
            AccountId id;

            Utf8String accCode;

            AccountType accType;
        };

        struct Currency {
            CurrencyCode code;

            Utf8String baseName;

            Utf8String fractionName;

            Utf8String baseSymbol;

            Utf8String fractionSymbol;
        };

        struct RoundUpDown {
            double threshold;

            double gridSpace;
        };

        struct RoundRule {
            RoundRuleId id;

            Utf8String name;

            Utf8String desc;

            RoundRuleType type;

            RoundUpDown roundValue;
        };

        struct TaxKey {
            TaxKeyId id;

            Utf8String name;

            TaxKeyType tkType;

            boolean wildCard;
        };

        struct Money {
            CurrencyCode currency;

            double amount;
        };

        struct ChargeTraits {
            ChargeTraitsId id;

            CurrencyCode currency;

            RoundRuleId rrId;

            Utf8String accCode;

            Utf8String numberFormat;

            TaxKeyId tkId;

            ChargeType cType;
        };

        typedef sequence<Unit> UnitSeq;

        typedef sequence<ChargeTraits> ChargeTraitsSeq;

        typedef sequence<RoundRule> RoundRuleSeq;

        typedef sequence<TaxKey> TaxKeySeq;

        typedef sequence<Account> AccountSeq;

        typedef sequence<Currency> CurrencySeq;

        struct CurrencyBook {
            CurrencySeq currSeq;

            CurrencyCode  baseCurrency;
        };

        interface Accounting {
            ChargeTraits getChargeTraits(in ChargeTraitsId id)
                raises (OsbCorbaException);

            ChargeTraitsSeq getChargeTraitses()
                raises (OsbCorbaException);

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

            AccountSeq getAccounts()
                raises (OsbCorbaException);

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

            CurrencyBook getCurrencyBook()
                raises (OsbCorbaException);

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

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

            RoundRuleSeq getRoundRules()
                raises (OsbCorbaException);

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

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

            TaxKeySeq getTaxKeys()
                raises (OsbCorbaException);

            TaxKeySeq getAssocTaxKeys()
                raises (OsbCorbaException);

            TaxKeySeq getContractTaxKeys()
                raises (OsbCorbaException);

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

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

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

            UnitSeq getUnits()
                raises (OsbCorbaException);

        };
    };
};
#endif                                  // #ifndef _CHARGETRAITS_IDL

---