tariff-gw.h

Go to the documentation of this file.

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

  RCS information
   $Name: OSB_060808 $
   $Revision: 1.28 $

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

// ************************************************************************
// included header files
// + standard includes

// + local headers
#include "tariff.h"

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

// ************************************************************************
// namespace extensions
namespace OSB_DB {

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

    // ********************************************************************
    // class RateCodeGw
    class RateCodeGw {
        friend class OSB_LIB::RateCodes;
    private:
        void read(
            const Session&                  session,
                  OSB_LIB::RateCodes::Cont& dest
        );

        void insert(
            const Session&           session,
                  OSB_LIB::RateCode* rc
        );

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

        void remove(
            const Session&           session,
                  OSB_LIB::RateCode* rc
        );

        void lock(
            const Session&           session,
                  OSB_LIB::RateCode* rc
        );

        void checkUniqueness(
            const Session&           session,
            const OSB_LIB::RateCode& rc
        );
    };                                  // class RateCodeGw

    // ********************************************************************
    // struct TariffGw
    struct TariffGw {
        friend class OSB_LIB::Tariff;

        bool fetch(
            const Session&         session,
                  OSB_LIB::Tariff& tf
        );

        long fetch(
            const Session&          session,
                  OSB_LIB::Tariffs& tfs
        );

    private:
        bool insTariff(
            const Session&         session,
                  OSB_LIB::Tariff& tf
        );

        bool delTariff(
            const Session&         session,
                  OSB_LIB::Tariff& tf
        );

        bool updTariff(
            const Session&         session,
                  OSB_LIB::Tariff& tf
        );

        OSB_LIB::ObjectStatus checkObjVs(
            const Session&         session,
            const OSB_LIB::Tariff& tf
        );
    };                                  // struct TariffGw

    // ********************************************************************
    // struct TfVersionGw
    struct TfVersionGw {
        friend class OSB_LIB::TfVersion;

        bool fetch(
            const Session&            session,
                  OSB_LIB::TfVersion& tfv
        );

        long fetch(
            const Session&             session,
                  OSB_LIB::TfVersions& tfvs
        );

    private:
        bool insTfVersion(
            const Session&            session,
                  OSB_LIB::TfVersion& tfv
        );

        bool delTfVersion(
            const Session&            session,
                  OSB_LIB::TfVersion& tfv
        );

        bool updTfVersion(
            const Session&            session,
                  OSB_LIB::TfVersion& tfv
        );

        OSB_LIB::ObjectStatus checkObjVs(
            const Session&            session,
            const OSB_LIB::TfVersion& tfv
        );

        bool allRatingFnsChecked(
            const Session&                 session,
            const OSB_LIB::TfVersion::Oid& oid
        );

        bool allRatingFnsReleased(
            const Session&                 session,
            const OSB_LIB::TfVersion::Oid& oid
        );

        bool isReleasedInFuture(
            const Session&                 session,
            const OSB_LIB::TfVersion::Oid& oid
        );

        bool uniqueReleaseTs(
            const Session&              session,
            const OSB_LIB::Tariff::Oid& oid,
            const OSB_LIB::DateTime&    ts
        ) const;

        bool isTariffUsedByReleasedTsVersion(
            const Session&              session,
            const OSB_LIB::Tariff::Oid& oid
        );

        bool isTariffUsedByFreezedTsVersion(
            const Session&              session,
            const OSB_LIB::Tariff::Oid& oid
        );

        OSB_LIB::DateTime findReplacementReleasedTfVersion(
            const Session&                 session,
            const OSB_LIB::TfVersion::Oid& oid
        );

        bool hasOtherReleasedTfVersion(
            const Session&                 session,
            const OSB_LIB::TfVersion::Oid& oid
        );

        bool findReplacementFreezedTfVersion(
            const Session&                 session,
            const OSB_LIB::TfVersion::Oid& oid
        );

        bool setStatus(
            const Session&            session,
                  OSB_LIB::TfVersion& tfVs,
                  OSB_LIB::CfgStatus  status
        );


        bool existReleasedTfVs(
            const Session&                 session,
            const OSB_LIB::Date&           backDate,
            const OSB_LIB::TfVersion::Oid& oid
        );

        bool patch(
            const Session&            session,
                  OSB_LIB::TfVersion& tfVs,
                  OSB_LIB::TfVersion& newTfVs
        );
    };                                  // struct TfVersionGw
}                                       // namespace OSB_DB
#endif                                  // #ifndef _TARIFFGW_H_

---