billingxml.h

Go to the documentation of this file.

// OSB library ********************************************* -*- C++ -*-
/*
  AUTHOR(S): Andreas Huggel (ahu)

  RCS information
   $Name: OSB_060808 $
   $Revision: 1.61 $

  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 _BILLINGXML_H_
#define _BILLINGXML_H_

// *********************************************************************
// included header files
// + standard includes
#include <iosfwd>

// + local headers
#include "osbxml.h"
#include "osbunit.h"
#include "associate.h"
#include "section.h"

// + class declarations
namespace OSB_LIB {
    class AssociateList;
    class AssociateInfo;
    class BaseAmount;
    class Contract;
    class Invoice;
    class InvoiceInfo;
    class InvoiceInfoItem;
    class OnetimeChargeItem;
    class Section;
    class SubsItem;
    class SumCdr01;
    class SumCdr01Detail;
    class SumCdr01Item;
    class SummaryCharges;
    class SummaryChargesInfo;
    class TaxAmount;
    class TotalItem;
    class Usagerecord;
    class UsagerecordDetail;
    class UsagerecordItem;
    struct OnetimeCharge;
    struct SubsCharge;
};

// *********************************************************************
// namespace extensions
namespace OSB_LIB {

// *********************************************************************
// class definitions


    class BillingXmlBase {
    public:
        BillingXmlBase(std::ostream& o)
            : xml(o),
              last_(Section::globalSection()),
              globalSectionWritten_(false)
        {};

        virtual ~BillingXmlBase() {}

        virtual void writeInvoice(
                  Invoice&       invoice,
            const Contract&      contract,
            const AssociateList& associates
        ) = 0;

        virtual void writeXmlHeader() = 0;

        virtual void writeXmlFooter() = 0;

        // -------------------------------------------------------------
        // public data members

        OsbXml xml;

    protected:
        Section last_;

        bool globalSectionWritten_;
    };  // Class BillingXmlBase

    class BillingXml : public BillingXmlBase {
    public:
        BillingXml(std::ostream& o) : BillingXmlBase(o) {}
        virtual ~BillingXml() {}

        virtual void writeInvoice(
            Invoice& invoice,
            const Contract& contract,
            const AssociateList& associates
        );

        virtual void writeUsagerecordItem(
            const UsagerecordItem& usagerecordItem
        );

        virtual void writeSubsItem(const SubsItem& subsItem);

        virtual void writeOtcItem(const OnetimeChargeItem& otcItem);

        virtual void writeTotalItem(const TotalItem& totalItem);

        virtual void writeOtc(const OnetimeCharge& otc);

        virtual void writeSubsCharge(const SubsCharge& subsCharge);

        virtual void writeBaseAmount(const BaseAmount& baseAmount);

        virtual void writeTaxAmount(const TaxAmount& taxAmount);

        virtual void writeMoney(
            const Money& money,
            bool withCurrency = true
        );

        virtual void writeAddress(
            const Address&    address,
                  AddressType addressType
        );

        virtual void writeAssociate(const Associate& associate);

        virtual void writeSummaryCharges(
            const SummaryCharges& sumCharges
        );

        virtual void writeInvoiceInfo(
            const InvoiceInfo& invInfo
        );

        void writeSection(
            const Section& section,
            const Contract& contract,
            const AssociateList& associates
        );

        virtual void writeXmlHeader();

        virtual void writeXmlFooter();

        virtual void writeUsagerecordDetail(
            const UsagerecordDetail& UsagerecordDetail
        );
    protected:
        virtual void writeUsagerecord(const Usagerecord& usagerecord);
    };

    class SumCdr01BillingXml : public BillingXml {
    public:
        SumCdr01BillingXml(std::ostream& o) : BillingXml(o) {}
        virtual ~SumCdr01BillingXml() {}

        virtual void writeSumCdr01Item(
            const SumCdr01Item& usageItem
        );

        virtual void writeSumCdr01Detail(
            const SumCdr01Detail& usageDetail
        );
    };
}                                       // namespace OSB_LIB
#endif                                  // #ifndef _BILLINGXML_H_

---