tariffclass.h

Go to the documentation of this file.

// OSB library ********************************************* -*- C++ -*-
/*
  AUTHOR(S): Stephan Broennimann (vb)

  RCS information
   $Name: OSB_060808 $
   $Revision: 1.55 $

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

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

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

// ************************************************************************
// class declarations
namespace OSB_DB {
    class Session;
    class TariffSystemGw;
    class TcsVersionGw;
    struct TariffClassGw;
    struct TcSystemGw;
}

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

// *********************************************************************
// forward declarations
    class OsbException;
    class ServiceClass;
    class Cdr;
    class UsedService;

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

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

    /*
     @brief Type of tariff classification system.

     Currently, three types of classification system are supported.
    */
    enum TcsType {

        tcsZone     = 1,

        tcsDirect   = 2,

        tcsSsAction = 3,

        tcsUnknown  = 0
    };

    // *****************************************************************
    // class TariffClass
    class TariffClass : public TariffObject {
        friend class TariffCatalogue;
        friend class OSB_DB::TariffClassGw;
    public:
        typedef Id<TariffClass> Oid;
    public:
        explicit TariffClass(const Oid& oid = Oid());
    public:
        const Oid& oid() const;

        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_;
    };

    typedef std::list<TariffClass> TariffClasses;

    // *****************************************************************
    // class TcSystem
    class TcSystem : public TariffObject {
        friend struct OSB_DB::TcSystemGw;
        friend class TariffCatalogue;
    public:
        typedef Id<TcSystem> Oid;

        enum TcsType {
            tcsUnknown = 0,             
            tcsDist    = 1,             
            tcsMapping = 2              
        };
    public:
        static TcsType mkTcsType(long t) throw();
        static long toLong(TcsType t) throw();
    public:

        explicit TcSystem(const Oid& oid = Oid());
    public:
        const Oid& oid() const;
        TcsType tcsType() const;

        const std::set<TariffClass::Oid> supportedTc() const;

        void setTcsType(TcsType tcsType);

        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_;             
        TcsType     tcsType_;         
    };

    typedef std::list<TcSystem> TcSystems;

    typedef std::list<TcSystem::Oid> TcSystemOids;

    // *****************************************************************
    // TcsVersion
    class TcsVersion : public ToVersion {
        friend struct OSB_DB::TcsVersionGw;
        friend class TariffCatalogue;
    public:
        typedef Id2<TcsVersion> Oid;
        typedef std::auto_ptr<TcsVersion> AutoPtr;
        explicit TcsVersion(const TcSystem::Oid& tcsId);

        virtual ~TcsVersion();

        AutoPtr clone() const;

        template<typename T> T* isa(T*& ptr);

        template<typename T> const T* isa(const T*& ptr) const;
    protected:
        TcsVersion& operator=(const TcsVersion& rhs);
    public:


        const Oid& oid() const;
        const TcSystem::Oid tcsId() const;
        long vs() const;

        virtual TcSystem::TcsType type() const = 0;

        virtual void copyCfg(const TcsVersion* src) = 0;
        virtual void supportedTc(
            std::set<TariffClass::Oid>& tcOids
        ) const = 0;



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

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

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

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

        virtual TariffClass::Oid getTc(
            Cdr&         cdr,
            UsedService& service
        ) const = 0;
    private:
        virtual TcsVersion* clone_() const = 0;

        virtual bool canFreeze(
            const OSB_DB::Session& session,
                  OsbErrors&       errors
        ) const = 0;

        virtual bool canRelease(
            const OSB_DB::Session& session,
                  OsbErrors&       errors
        ) const = 0;

        virtual bool canRevoke(
            const OSB_DB::Session& session,
                  OsbErrors&       errors
        ) const = 0;

        virtual bool canUnfreeze(
            const OSB_DB::Session& session,
                  OsbErrors&       errors
        ) const = 0;

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

        virtual bool insSpecific(
            const OSB_DB::Session& session
        ) = 0;

        virtual bool delSpecific(
            const OSB_DB::Session& session
        ) = 0;

        virtual bool updSpecific(
            const OSB_DB::Session& session
        ) = 0;


    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_;
    };                                  // class TcsVersion

    // *****************************************************************
    // TcsVersions
    struct TcsVersions {


        typedef std::list<TcsVersion*> List;
        typedef List::iterator Iterator;
        typedef List::const_iterator ConstIterator;
        typedef List::size_type SizeType;

        TcsVersions();
        TcsVersions(const TcsVersions& rhs);
        TcsVersions& operator=(const TcsVersions& rhs);
        ~TcsVersions();


        Iterator       begin();
        Iterator       end();
        ConstIterator begin() const;
        ConstIterator end() const;
        SizeType      size() const;
        void swap(TcsVersions& rhs);

        void pushBack(const TcsVersion& tcsVs);

        void pushBack(TcsVersion::AutoPtr tcsVs);

        void erase(const TcsVersion::Oid& tcsVs);

        void clear();
    public:
        List list_;
    };

    // *****************************************************************
    // TcsVersionFactory
    class TcsVersionFactory {
    public:
        static TcsVersion::AutoPtr create(
            const TcSystem::TcsType& type,
            const TcSystem::Oid&     tcsId
        );

    private:
        TcsVersionFactory();
        TcsVersionFactory(const TcsVersionFactory& rhs);
    };

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

    // *****************************************************************
    // TcsVersion
    template<typename T> T* TcsVersion::isa(T*& ptr)
    {
        ptr = dynamic_cast<T*>(this);
        return ptr;
    }

    template<typename T> const T* TcsVersion::isa(const T*& ptr) const
    {
        ptr = dynamic_cast<const T*>(this);
        return ptr;
    }
}                                       // namespace OSB_LIB
#endif                                  // #ifndef _TARIFFCLASS_H_

---