balancesheet.idl

Go to the documentation of this file.

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

  RCS information
   $Name: OSB_060808 $
   $Revision: 1.23.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 BALANCESHEET_IDL
#define BALANCESHEET_IDL
// *********************************************************************
#include "cadmin.idl"
#include "chargetraits.idl"
#include "corba_status.idl"
#include "corba_utility.idl"
#include "productpart.idl"

module corba {
    module cadmin {
        module contract{
            enum BpStatus {
                bpUnknown,        //<! Unknown status.
                bpNormal,         //<! Normal state.
                bpRerate,         //<! Re-rating required.
                bpBillingFailed,  //<! Billing failed for the page.
                bpDontBill        //<! Don't bill the balance page.
            };

            struct SubTotal {
                common::CurrencyCode currency;

                double usageCharges;

                double otCharges;

                double advCharges;
            };

            typedef sequence<SubTotal> BsTotal;

            struct AdvanceCharge {
                AdvId id;

                double amount;

                common::ChargeTraitsId ctId;

                cadmin::PersProdId persId;

                pcat::pp::ProductPartId ppId;

                common::Date periodStart;

                common::Date periodEnd;

                common::DateTime assigned;

                common::Utf8String remark;
            };

            struct OnetimeCharge {
                OtcId id;

                StatusChange sc;

                cadmin::PersProdId persId;

                pcat::pp::ProductPartId ppId;

                common::Money charge;

                common::ChargeTraitsId ctId;

                common::DateTime assigned;

                common::Utf8String remark;
            };

            struct UsageCharge {
                common::CurrencyCode currency;

                double amount;
            };

            typedef sequence<UsageCharge> UsageChargeSeq;

            typedef sequence<OnetimeCharge> OnetimeChargeSeq;

            typedef sequence<AdvanceCharge> AdvanceChargeSeq;

            interface BsPageWriter {
                readonly attribute BsPageId id;

                BpStatus status()
                    raises (common::OsbCorbaException);

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

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

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

                common::Date startDate()
                    raises (common::OsbCorbaException);

                common::Date endDate()
                    raises (common::OsbCorbaException);

                common::DateTime opened()
                    raises (common::OsbCorbaException);

                common::DateTime closed()
                    raises (common::OsbCorbaException);

                common::DateTime lastCharged()
                    raises (common::OsbCorbaException);

                BsTotal charges()
                    raises (common::OsbCorbaException);

                OnetimeCharge getOnetimeCharge(
                    in OtcId id,
                    in boolean noWait
                ) raises (common::OsbCorbaException);

                OnetimeChargeSeq getOnetimeCharges(
                    in boolean noWait
                ) raises (common::OsbCorbaException);

                OnetimeChargeSeq getOtcOfPersProd(
                    in cadmin::PersProdId persId,
                    in boolean noWait
                ) raises (common::OsbCorbaException);

                OnetimeChargeSeq getOtcOfPersProdNode(
                    in pcat::pp::ProductPartId ppId,
                    in boolean noWait
                ) raises (common::OsbCorbaException);

                readonly attribute AdvanceChargeSeq getAdvanceCharges;

                boolean removeOtc(
                    in OtcId id,
                    in boolean noWait
                ) raises (common::OsbCorbaException);
            };                          // interface BsPageWriter

            interface BalanceSheetWriter {
                BsPageWriter getBsPage(
                    in BsPageId id
                ) raises (common::OsbCorbaException);

                BsPageSeq getBsPages()
                    raises (common::OsbCorbaException);

                BsTotal totalCharges();

                BsPageId addOtc(
                    in OnetimeCharge otc,
                    in boolean noWait
                ) raises (common::OsbCorbaException);

                readonly attribute boolean hasOtc;

                readonly attribute boolean hasAdvCharges;
            };                          // interface BalanceSheet
        };
    };
};
#endif                                  // #ifndef BALANCESHEET_IDL

---