billcycle.h

Go to the documentation of this file.

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

  RCS information
   $Name: OSB_060808 $
   $Revision: 1.42 $

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

// *********************************************************************
// included header files
// + standard includes
#include <list>
#include <vector>
#include <map>
#include <set>

// + local headers
#include "osbid.h"
#include "chrono.h"

// *********************************************************************
// class declarations
namespace OSB_DB {
    class Session;
    class BillcycleGw;
}

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

// *********************************************************************
// forward declarations
    class TheBillcycleFactory;

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

    class Billcycle {
        friend class OSB_DB::BillcycleGw;
        friend class TheBillcycleFactory;
    public:
        typedef Id<Billcycle> Oid;

        typedef std::auto_ptr<Billcycle> AutoPtr;

        enum Type {
            btUnknown           = 0,    // unknown billcycle type
            btIntervalBillcycle = 1,
            btDateBillcycle     = 2,
            btMidMonthBillcycle = 3
        };

        static long toLong(Type bt);

        static Type type(long bt);

    public:
        virtual ~Billcycle() {}

        AutoPtr clone() const;



        const Oid& oid() const { return id_; }
        const std::string& name() const { return name_; }
        const std::string& des() const { return des_; }

        virtual Date addBillingPeriod(const Date& from) const =0;

        virtual int readSpecific(
            const OSB_DB::Session& session
        ) =0;

    private:
        virtual Billcycle* clone_() const = 0;

    private:
        Oid         id_;                
        std::string name_;              
        std::string des_;               
    }; // class Billcycle

    class DateBillcycle : public Billcycle {
    public:
        // Documentation from base class.
        typedef std::auto_ptr<DateBillcycle> AutoPtr;

        // Default constructor provided by compiler.

        Date addBillingPeriod(const Date& from) const;

        // Documentation from base class.
        int readSpecific(const OSB_DB::Session& session);

        // Documentation from base class.
        AutoPtr clone() const;

    private:
        // Documentation from base class.
        virtual Billcycle* clone_() const;

    }; // class DateBillcycle

    class IntervalBillcycle : public Billcycle {
        friend class OSB_DB::BillcycleGw;
    public:
        // Documentation from base class.
        typedef std::auto_ptr<IntervalBillcycle> AutoPtr;

        enum Unit {
            utUnknown = '\0',          // unknown unit
            utDays    = 'd',           // database: 'd'
            utMonths  = 'm'            // database: 'm'
        };

        static char toChar(Unit ut);

        static Unit unit(char ut);

        IntervalBillcycle()
            : Billcycle(), unit_(utUnknown), interval_(0),
              startDay_(0), minPeriod_(0) {}


        Unit unit() const { return unit_; }
        int interval() const { return interval_; }
        int startDay() const { return startDay_; }
        int minPeriod() const { return minPeriod_; }

        Date addBillingPeriod(const Date& from) const;

        // Documentation from base class.
        int readSpecific(const OSB_DB::Session& session);

        // Documentation from base class.
        AutoPtr clone() const;

    private:
        Unit unit_;
        int interval_;
        int startDay_;
        int minPeriod_;
        // Documentation from base class.
        virtual Billcycle* clone_() const;
    }; // class IntervalBillcycle

    class MidMonthBillcycle : public Billcycle {
        friend class OSB_DB::BillcycleGw;
    public:
        // Documentation from base class.
        typedef std::auto_ptr<MidMonthBillcycle> AutoPtr;

        MidMonthBillcycle()
            : Billcycle(), midMonth_(0), minPeriod_(0) {}


        int midMonth() const { return midMonth_; }
        int minPeriod() const { return minPeriod_; }

        Date addBillingPeriod(const Date& from) const;

        // Documentation from base class.
        int readSpecific(const OSB_DB::Session& session);

        // Documentation from base class.
        AutoPtr clone() const;

    private:
        int midMonth_;
        int minPeriod_;

        // Documentation from base class.
        virtual Billcycle* clone_() const;
    }; // class MidMonthBillcycle

    class BillcycleList {
    public:


        typedef std::vector<Billcycle*> List;
        typedef List::iterator Iterator;
        typedef List::const_iterator ConstIterator;
        typedef List::size_type SizeType;

        BillcycleList() {};

        BillcycleList(const BillcycleList& rhs);

        BillcycleList& operator=(const BillcycleList& rhs);

        ~BillcycleList();


        Iterator begin() { return list_.begin(); }
        Iterator end() { return list_.end(); }
        ConstIterator begin() const { return list_.begin(); }
        ConstIterator end() const { return list_.end(); }
        SizeType size() const { return list_.size(); }
        void swap(BillcycleList& rhs);

        void push_back(const Billcycle& bc);

        void push_back(Billcycle::AutoPtr ap);

        Iterator erase(Iterator pos);

        void clear();

        const List& list() const { return list_; }

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

        Billcycle* findBillcycle(const Billcycle::Oid& oid) const;

        Billcycle& getBillcycle(const Billcycle::Oid& oid) const;

    private:
        List list_;
    }; // class BillcycleList

    // *****************************************************************
    // TheBillcycleFactory
    class TheBillcycleFactory {
    public:
        static TheBillcycleFactory* instance();

        Billcycle::AutoPtr create(Billcycle::Type type);

        Billcycle::AutoPtr create(
                  Billcycle::Type type,
            const Billcycle::Oid& bcId
        );

        void registerBillcycle(
            Billcycle::Type type,
            Billcycle::AutoPtr billcycle
        );

    protected:
        TheBillcycleFactory();
        TheBillcycleFactory(const TheBillcycleFactory& rhs);

    private:
        static TheBillcycleFactory* instance_;
        typedef std::map<Billcycle::Type, Billcycle*> Registry;
        Registry registry_;

    }; // class TheBillcycleFactory
}                                       // namespace OSB_LIB
#endif                                  // #ifndef _BILLCYCLE_H_

---