contractadmin.idl

Go to the documentation of this file.

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

  RCS information
   $Name: OSB_060808 $
   $Revision: 1.38.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 CONTRACTADMIN_IDL
#define CONTRACTADMIN_IDL
// ************************************************************
#include "anclist.idl"
#include "associate.idl"
#include "corba_status.idl"
#include "corba_utility.idl"
#include "product.idl"
#include "tariffobject.idl"

module corba {
    module cadmin {
        struct Product {
            pcat::pd::ProductId id;

            common::Utf8String name;

            common::Utf8String desc;
        };

        typedef sequence<Product> ProductSeq;

        struct PpType {
            pcat::pp::PpTypeId id;

            common::Utf8String name;

            common::Utf8String desc;
        };

        struct ProductPart {
            pcat::pp::ProductPartId id;

            pcat::pp::ProductPartId parentId;

            PpType type;

            common::Utf8String name;

            common::Utf8String desc;

            boolean canPersonalize;

            long mandatory;

            common::Utf8String configDes;

            common::Utf8String defPersDes;
        };

        interface ContractAdmin {
            readonly attribute common::ServerInfo getServerInfo;

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

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

            ProductSeq getProducts();

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

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

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

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

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

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

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

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

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

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

            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);



            tcat::ts::TariffSystem getTariffSystem(
                in tcat::ts::TariffSystemId tsId
            ) raises (common::OsbCorbaException);

            tcat::ts::TariffSystemSeq getTariffSystems();



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

            common::CfgErrorSeq delStatusRequest(
                in StatusRequestId srqId
            ) raises (common::OsbCorbaException);
       };
    };
};
#endif                                  // CONTRACTADMIN_IDL

---