tariffobject.h

Go to the documentation of this file.

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

  RCS information
   $Name: OSB_060808 $
   $Revision: 1.37 $

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

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

// + libraries

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

// ************************************************************************
// class declarations
namespace OSB_LIB {
    class OsbErrors;
}

namespace OSB_DB {
    class Session;
}

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

// ************************************************************************
// class definitions
    class ToCfgBase {
    protected:
        explicit ToCfgBase(CfgStatus status = cfgEditable);
        virtual ~ToCfgBase();
        ToCfgBase& operator=(const ToCfgBase& rhs);
    public:
        CfgStatus status() const;
        virtual bool freeze(
            const OSB_DB::Session& session,
                  OsbErrors&       msgs
        ) = 0;

        virtual bool release(
            const OSB_DB::Session& session,
                  OsbErrors&       msgs
        ) = 0;

        virtual bool revoke(
            const OSB_DB::Session& session,
                  OsbErrors&       msgs
        ) = 0;

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

    protected:
        CfgStatus status_;
    };

    class ToCfgTsBase : public ToCfgBase {
    protected:
        explicit ToCfgTsBase(CfgStatus status = cfgEditable);
        virtual ~ToCfgTsBase();
        ToCfgTsBase& operator=(const ToCfgTsBase& rhs);
    public:
        const DateTime& releaseTs() const;

        virtual void setReleaseTs(const DateTime& ts);
    protected:
        DateTime releaseTs_;
    };                                  // class ToCfgTsBase

    class ToCfgPeriodBase : public ToCfgTsBase {
    protected:
        explicit ToCfgPeriodBase(CfgStatus status = cfgEditable);
        virtual ~ToCfgPeriodBase();
        ToCfgPeriodBase& operator=(const ToCfgPeriodBase& rhs);
    public:
        const DateTime& endTs() const;
        virtual void setEndTs(const DateTime& ts);
        bool contains(const DateTime& ts) const;
    protected:
        DateTime endTs_;
    };                                  // class ToCfgPeriodBase

    class ToVersion : public ToCfgTsBase {
    protected:                          // construction, destruction
        ToVersion();
        virtual ~ToVersion();
    protected:
        ToVersion& operator=(const ToVersion& rhs);
    public:
        const std::string& name() const;
        virtual void setName(const std::string& name);
    protected:
        long objVs() const;
    protected:
        std::string name_;
    protected:
        long objVs_;
    };                                  // class ToVersion

    class TariffObject {
    protected:                          // construction, destruction
        TariffObject();
        virtual ~TariffObject() = 0;
    protected:
        TariffObject& operator=(const TariffObject& rhs);
    public:                             // access to members
        const std::string& name() const;
        const std::string& des() const;

        void setName(const std::string& name);
        void setDes(const std::string& des);

    protected:
        long objVs() const;
// ToDo: do we really need this?
/*
 *      virtual void lock(
 *          const OSB_DB::Session& session,
 *          const bool             noWait
 *      ) = 0;
 */
    protected:
        std::string name_;
        std::string des_;
    protected:
        long objVs_;
    };                                  // class TariffObject

    class ToNameOnly {
    protected:                          // construction, destruction
        ToNameOnly();
        virtual ~ToNameOnly() = 0;
    protected:
        ToNameOnly& operator=(const ToNameOnly& rhs);
    public:                             // access to members
        const std::string& name() const;
        void setName(const std::string& name);
    protected:
        long objVs() const;
    protected:
        std::string name_;
        long objVs_;
    };                                  // class ToNameOnly

// ************************************************************************
// free functions

    bool greaterToReleaseTsRef(
        const ToCfgTsBase& lhs,
        const ToCfgTsBase& rhs
    );
    bool greaterToReleaseTsPtr(
        const ToCfgTsBase* lhs,
        const ToCfgTsBase* rhs
    );
}                                       // namespace OSB_LIB
#endif                                  // #ifndef _TARIFFOBJECT_H_

---