tariffperiod-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 _TARIFFPERIODGW_H_
#define _TARIFFPERIODGW_H_

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

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

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

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

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

    // *****************************************************************
    // DayClassGw
    struct DayClassGw {
        friend class OSB_LIB::DayClass;

        long fetch(
            const Session&             session,
                  OSB_LIB::DayClasses& dcs
        );

        bool fetch(
            const Session&           session,
                  OSB_LIB::DayClass& dc
        );

    private:
        bool insDayClass(
            const Session&           session,
                  OSB_LIB::DayClass& dc
        );

        bool delDayClass(
            const Session&           session,
                  OSB_LIB::DayClass& dc
        );

        bool updDayClass(
            const Session&           session,
                  OSB_LIB::DayClass& dc
        );

        OSB_LIB::ObjectStatus checkObjVs(
            const Session&           session,
            const OSB_LIB::DayClass& dc
        );

        OSB_LIB::CfgStatus getStatus(
            const Session&                session,
            const OSB_LIB::DayClass::Oid& oid
        );

        void updStatus(
            const Session&           session,
                  OSB_LIB::DayClass& dc
        );

        bool hasFreezedSpecialDate(
            const Session&                session,
            const OSB_LIB::DayClass::Oid& oid
        );

        bool hasReleasedSpecialDate(
            const Session&                session,
            const OSB_LIB::DayClass::Oid& oid
        );

        bool isUsedByFreezedTpVersion(
            const Session&                session,
            const OSB_LIB::DayClass::Oid& oid
        );

        bool isUsedByReleasedTpVersion(
            const Session&                session,
            const OSB_LIB::DayClass::Oid& oid
        );
    };

    // *****************************************************************
    // SpecialDateGw
    struct SpecialDateGw {
        friend class OSB_LIB::SpecialDate;

        long fetch(
            const Session&               session,
                  OSB_LIB::SpecialDates& sds
        );

        bool fetch(
            const Session&              session,
                  OSB_LIB::SpecialDate& sd
        );

    private:
        bool insSpecialDate(
            const Session&              session,
                  OSB_LIB::SpecialDate& sd
        );

        bool delSpecialDate(
            const Session&              session,
                  OSB_LIB::SpecialDate& sd
        );

        bool updSpecialDate(
            const Session&              session,
                  OSB_LIB::SpecialDate& sd
        );

        OSB_LIB::ObjectStatus checkObjVs(
            const Session&              session,
            const OSB_LIB::SpecialDate& sd
        );

        OSB_LIB::CfgStatus getStatus(
            const Session&                   session,
            const OSB_LIB::SpecialDate::Oid& sdId
        );

        void updStatus(
            const Session&              session,
                  OSB_LIB::SpecialDate& sd
        );

        bool dateInFuture(
            const Session&              session,
            const OSB_LIB::SpecialDate& sd
        );

        bool dayClassFreezed(
            const Session&              session,
            const OSB_LIB::SpecialDate& sd
        );

        bool dayClassReleased(
            const Session&              session,
            const OSB_LIB::SpecialDate& sd
        );
    };                                  // struct SpecialDateGw

    // *****************************************************************
    // TariffPeriodGw
    struct TariffPeriodGw {
        friend class OSB_LIB::TariffPeriod;

        long fetch(
            const Session&                session,
                  OSB_LIB::TariffPeriods& tps
        );

        bool fetch(
            const Session&               session,
                  OSB_LIB::TariffPeriod& tp
        );

    private:
        bool insTariffPeriod(
            const Session&               session,
                  OSB_LIB::TariffPeriod& tp
        );

        bool updTariffPeriod(
           const Session&               session,
                 OSB_LIB::TariffPeriod& tp
        );

        bool delTariffPeriod(
            const Session&               session,
                  OSB_LIB::TariffPeriod& tp
        );

        OSB_LIB::ObjectStatus checkObjVs(
            const Session&               session,
            const OSB_LIB::TariffPeriod& tp
        );
    };

    // *****************************************************************
    // TpSystem
    struct TpSystemGw {
        friend class OSB_LIB::TpSystem;

        long fetch(
            const Session&            session,
                  OSB_LIB::TpSystems& tpss
        );

        bool fetch(
            const Session&           session,
                  OSB_LIB::TpSystem& tps
        );

    private:
        bool insTpSystem(
            const Session&           session,
                  OSB_LIB::TpSystem& tps
        );

        bool updTpSystem(
            const Session&           session,
                  OSB_LIB::TpSystem& tps
        );

        bool delTpSystem(
            const Session&           session,
                  OSB_LIB::TpSystem& tps
        );

        OSB_LIB::ObjectStatus checkObjVs(
            const Session&           session,
            const OSB_LIB::TpSystem& tps
        );
    };

    // *****************************************************************
    // TpsVersionGw
    struct TpsVersionGw {
        friend class OSB_LIB::TpsVersion;

        long fetch(
            const Session&              session,
                  OSB_LIB::TpsVersions& tpsvs
        );

        bool fetch(
            const Session&             session,
                  OSB_LIB::TpsVersion& tpsv
        );

    private:
        bool insTpsVersion(
            const Session&             session,
                  OSB_LIB::TpsVersion& tpsv
        );

        bool delTpsVersion(
            const Session&             session,
                  OSB_LIB::TpsVersion& tpsv
        );

        bool updTpsVersion(
            const Session&             session,
                  OSB_LIB::TpsVersion& tpsv
        );

        OSB_LIB::ObjectStatus checkObjVs(
            const Session&             session,
            const OSB_LIB::TpsVersion& tpsv
        );

        bool eachDayCoveredOnce(
            const Session&                  session,
            const OSB_LIB::TpsVersion::Oid& oid
        );

        bool checkSwitchTime(
            const Session&                  session,
            const OSB_LIB::TpsVersion::Oid& oid,
                  OSB_LIB::OsbErrors&       errors
        );

        bool allDayClassesFreezed(
            const Session&                  session,
            const OSB_LIB::TpsVersion::Oid& oid,
                  OSB_LIB::OsbErrors&       errors
        );

        bool checkDcSwitchTimeUnique(
            const Session&                  session,
            const OSB_LIB::TpsVersion::Oid& oid,
                  OSB_LIB::OsbErrors&       errors
        );

        bool switchTimeZeroDefined(
            const Session&                  session,
            const OSB_LIB::TpsVersion::Oid& oid,
                  OSB_LIB::OsbErrors&       errors
        );

        bool wholeWeekCover(
            const Session&                  session,
            const OSB_LIB::TpsVersion::Oid& oid
        );

        bool identicalTariffPeriod(
            const Session&                  session,
            const OSB_LIB::TpsVersion::Oid& oid
        );

        void updStatus(
            const Session&             session,
                  OSB_LIB::TpsVersion& tpsVs
        );

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

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

        bool allDayClassesReleased(
            const Session&                  session,
            const OSB_LIB::TpsVersion::Oid& oid,
                  OSB_LIB::OsbErrors&       errors
        );

        bool isTpSystemUsedByReleasedTsVersion(
            const Session&                session,
            const OSB_LIB::TpSystem::Oid& oid
        );

        bool isTpSystemUsedByFreezedTsVersion(
            const Session&                session,
            const OSB_LIB::TpSystem::Oid& oid
        );

        OSB_LIB::DateTime nextReleasedVersion(
            const Session&                  session,
            const OSB_LIB::TpsVersion::Oid& oid
        );

        bool hasOtherReleasedTpsVersion(
            const Session&                  session,
            const OSB_LIB::TpsVersion::Oid& oid
        );

        bool findReplacementFreezedTpsVersion(
            const Session&                  session,
            const OSB_LIB::TpsVersion::Oid& oid
        );
    };

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

}                                       // namespace OSB_DB
#endif                                  // #ifndef _TARIFFPERIODGW_H_

---