rpeval.h

Go to the documentation of this file.

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

  RCS information
   $Name: OSB_060808 $
   $Revision: 1.22.2.1 $

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

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

// + libraries

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

// + class declarations
namespace OSB_DB {
    class RpEvalGw;
    class Session;
}

namespace OSB_LIB {
    class Cdr;
    class OsbError;
    class RatedParty;
}

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

// ************************************************************************
// class definitions
    class RatedPartyEval {
        friend class OSB_DB::RpEvalGw;
    public:
        typedef Id<RatedPartyEval> Oid;
        typedef TypeId<RatedPartyEval> Type;
        typedef TypeId<RatedParty> RpType;

        enum Result {
            noCdr = 1,
            evalError,
            useRatedParty,
            useCache
        };

    public:
        RatedPartyEval(
            const Oid&    oid,
            const RpType& rpType
        );
        virtual ~RatedPartyEval();

    protected:
        RatedPartyEval(const RatedPartyEval& rhs);
        RatedPartyEval& operator=(const RatedPartyEval& rhs);

    public:
        const Oid& oid() const;

        inline RpType rpType() const;

        Result evalParty(
            const Cdr&        cdr,
                  RatedParty* rp,
                  OsbError*   error
        ) const;

        virtual Type type() const = 0;

        virtual bool requiresCache() const = 0;

    private:
        virtual Result getParty(
            const Cdr&        cdr,
                  RatedParty* rp,
                  OsbError*   error
        ) const = 0;

    public:
        virtual int numParam() const = 0;

        virtual std::string getParam(int index) const = 0;

    private:                            // database gateway only
        virtual bool setParam(
                  int          index,
            const std::string& param
        ) = 0;

    private:
        Oid oid_;
        RpType rpType_;
    };                                  // class RatedPartyEval
}                                       // namespace OSB_LIB

// ************************************************************************
// inline definitions
namespace OSB_LIB {
    inline const RatedPartyEval::Oid& RatedPartyEval::oid() const
    {
        return oid_;
    }

    inline RatedPartyEval::RpType RatedPartyEval::rpType() const
    {
        return rpType_;
    }
}                                       // namespace OSB_LIB
#endif                                  // #ifndef _RPEVAL_H_

---