tariff.h

Go to the documentation of this file.

// OSB library ********************************************* -*- C++ -*-
/*
  AUTHOR(S): Tang Boon Leong (tbl)

  RCS information
   $Name: OSB_060808 $
   $Revision: 1.43 $

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

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

// + local headers
#include "tariffobject.h"
#include "ratingfn.h"
#include "serviceclass.h"

// *********************************************************************
// class declarations
namespace OSB_DB {
    class  RateCodeGw;
    struct TariffGw;
    struct TfVersionGw;
    class  TariffSystemGw;
}

namespace OSB_LIB {
    class SumCdr;
}

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


// *********************************************************************
// type definitions

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

    // ********************************************************************
    // class RateCode
    class RateCode : public TariffObject {
        friend class OSB_DB::RateCodeGw;
    public:
        typedef Id<RateCode> Oid;
    public:
        explicit RateCode(const Oid& oid = Oid());
    public:
        const Oid& oid() const;
        const std::string& mnemonic() const;
        void setMnemonic(const std::string& mnemonic);
    private:
        Oid oid_;
        std::string mnemonic_;
    };                                  // class RateCode

    class RateCodes {
    public:
        typedef std::map<RateCode::Oid, RateCode> Cont;
    public:
        const Cont& codes() const;
        const RateCode& getRateCode(const RateCode::Oid& id);

        const RateCode* findRateCode(const RateCode::Oid& id);

        void read(const OSB_DB::Session& session);
    public:


        void create(
            const OSB_DB::Session& session,
                  RateCode*        rc
        );

        void update(
            const OSB_DB::Session& session,
                  RateCode*        rc
        );

        void remove(
            const OSB_DB::Session& session,
                  RateCode*        rc
        );
    private:
        Cont codes_;
    };                                  // class RateCodes

    // *****************************************************************
    // Tariff
    class Tariff : public TariffObject {
        friend class OSB_DB::TariffSystemGw;
        friend struct OSB_DB::TariffGw;
        friend class TariffCatalogue;
    public:
        typedef Id<Tariff> Oid;
    public:
        Tariff (const Oid& oid = Oid());
    public:


        const Oid& oid() const;
        bool rounded() const;



        void setRounded(bool rounded);

        bool read(const OSB_DB::Session& session);

    private:


        bool insert(const OSB_DB::Session& session);

        bool remove(const OSB_DB::Session& session);

        bool update(const OSB_DB::Session& session);

    private:
        Oid  oid_;                      
        bool rounded_;                  
    };

    typedef std::list<Tariff> Tariffs;

    // *****************************************************************
    // TfVersion
    class TfVersion : public ToVersion {
        friend struct OSB_DB::TfVersionGw;

        friend class TariffCatalogue;
    public:
        typedef Id2<TfVersion> Oid;
        typedef std::set< Id<RatingFn> > AssignedRf;
    public:
        explicit TfVersion(const Oid& oid = Oid());
        explicit TfVersion(const Tariff::Oid& tfOid);
    public:
        const Oid& oid() const;
        Tariff::Oid tfId() const;
        // documentation from base class.
        long vsId() const;
        const AssignedRf& ratingFns() const;

        void rate(
                  UsedService& us,
            const Money&       money,
                  Decimal&     volume
        ) const;

        void rate(UsedService& us) const;

        void rate(SumCdr& sumCdr) const;

        bool patch(
            const OSB_DB::Session& session,
                  OsbErrors&       errors,
                  TfVersion*       replacing
        );

        bool addRatingFn(const RatingFn::Oid& rfId);

        bool removeRatingFn(const RatingFn::Oid& rfId);

        bool freeze(
            const OSB_DB::Session& session,
                  OsbErrors&       errors
        );

        bool release(
            const OSB_DB::Session& session,
                  OsbErrors&       errors
//                  bool             patch = false
//          @param  patch   Flag to indicate if tariff version is a
//                          patch version. Defaulted to false.
        );

        bool revoke(
            const OSB_DB::Session& session,
                  OsbErrors&       errors
        );

        bool unfreeze(
            const OSB_DB::Session& session,
                  OsbErrors&       errors
        );

    private:
        bool checkObjVs(
            const OSB_DB::Session& session,
                  OsbErrors&       errors
        );

       bool hasReplacement(OSB_LIB::DateTime* nextVs) const;

       bool gracePeriodExpired() const;

    public:
        bool read(const OSB_DB::Session& session);

    private:


        bool insert(const OSB_DB::Session& session);

        bool remove(const OSB_DB::Session& session);

        bool update(const OSB_DB::Session& session);

    private:
        Oid oid_;
        AssignedRf ratingFns_;
    };

    typedef std::map<Tariff::Oid,
                     std::list<TfVersion> > TfVersions;

// *********************************************************************
// inline definitions

}                                       // namespace OSB_LIB
#endif                                  // #ifndef _TARIFF_H_

---