backdatedobject.h

Go to the documentation of this file.

// OSB library ************************************************ -*- C++ -*-
/*
  AUTHOR(S): Darryl Kang (dk)

  RCS information
   $Name: OSB_060808 $
   $Revision: 1.9 $

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

// ************************************************************************
// included header files

// + standard includes
#include <list>

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

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

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

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

    // class BackDatedObject
    class BackDatedObject {
    public:
        typedef Id<BackDatedObject> Oid;

        typedef Id2<BackDatedObject> ToId;

        enum TariffObject {
            toTfVersion = 'f'    

            // Add new tariff object below once back-dating for
            // the tariff object is supported.
        };

        static char toChar(TariffObject to);

        static TariffObject toTariffObject(char to);

        BackDatedObject(
            const Oid& oid,
            const ToId& patched,
            const ToId& substitute,
            TariffObject tariffObject,
            const Date& releasedDate,
            bool resubmitted = false
        );

        const Oid& oid() const { return oid_; }

        const ToId& patched() const { return patched_; }

        const ToId& substitute() const { return substitute_; }

        const Date& patchReleasedDate() const
        {
            return patchReleasedDate_;
        }

        TariffObject tariffObject() const { return tariffObject_; }

        bool resubmitted() const { return resubmitted_; }

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

    private:
        Oid oid_;
        ToId patched_;
        ToId substitute_;
        TariffObject tariffObject_;
        Date patchReleasedDate_;

        bool resubmitted_;
    };

    typedef std::list<BackDatedObject> BackDatedObjects;
}                                       // namespace OSB_LIB
#endif                                  // #ifndef _BACKDATEDOBJECT_H_

---