productitem.h

Go to the documentation of this file.

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

  RCS information
   $Name: OSB_060808 $
   $Revision: 1.13 $

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

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

// + libraries

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

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

namespace OSB_LIB {
    class PersProductItem;
}

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

// ************************************************************************
// forward declarations

// ************************************************************************
// type definitions

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

    // *****************************************************************
    // class ProductItemBase
    class ProductItemBase {
    public:
        typedef TypeId<ProductItemBase> Type;
    public:
        ProductItemBase();
        virtual ~ProductItemBase();

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

    public:
        template<typename P> P* isa(P*& ptr);
        template<typename P> const P* isa(const P*& ptr) const;

        virtual Type type() const = 0;
    };                                  // class ProductItemBase

    // *****************************************************************
    // class ProductItem
    class ProductItem : public ProductItemBase {
        friend class OSB_DB::ProductGw;

    public:
        typedef Id<ProductItem> Oid;

        typedef std::auto_ptr<ProductItem> AutoPtr;

        enum CfgType {
            cfgMandatory = -1,  
            cfgOptional  =  0,  
            cfgNone      =  1   
        };

        enum DefPersType {
            defPersMandatory = -1,
            defPersOptional  =  0,
            defPersNone      =  1
        };

        enum CfgPersType {
            persMandatory = -1,  
            persOptional  =  0,  
            persNone      =  1   
        };

        ProductItem(
            const Oid&         oid,
            const std::string& name = "",
            const std::string& desc = ""
        );

        AutoPtr clone() const;

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

    private:
        virtual ProductItem* clone_() const = 0;

    public:


        const Oid& oid() const { return oid_; }
        const std::string& name() const { return name_; }
        const std::string& desc() const { return des_; }
        virtual CfgType canConfigure() const = 0;
        virtual DefPersType canDefPers() const = 0;
        virtual CfgPersType canPersonalize() const = 0;
        virtual const PersProductItem* defPersItem() const = 0;

        const std::string& configDes() const { return configDes_; }
        const std::string& defPersDes() const { return defPersDes_; }



        void setName(const std::string& name);
        void setDesc(const std::string& desc);
        bool setConfigDes(const std::string& configDes);
        bool setDefPersDes(const std::string& defPersDes);

        virtual std::auto_ptr<PersProductItem>
            crePersProductItem() const = 0;

    public:
        bool read(
            const OSB_DB::Session& session,
                  bool             baseRead = false
        );

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

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

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

    private:
        virtual bool
        readSpecific(const OSB_DB::Session& session) = 0;

        virtual bool
        insSpecific(const OSB_DB::Session& session) = 0;

        virtual bool
        updSpecific(const OSB_DB::Session& session) = 0;

        virtual bool
        delSpecific(const OSB_DB::Session& session) = 0;

    public:
        virtual std::ostream& prInfo(std::ostream& os) const;

    private:
        Oid         oid_;         
        std::string name_;        
        std::string des_;         
    protected:
        std::string configDes_;
        std::string defPersDes_;
    };

    std::ostream& operator<<(
              std::ostream& o,
        const ProductItem&  pi
    );

    class DescriptionItem : public ProductItem {
    public:
        static const Type type_;
        // Documentation from base class.
        typedef std::auto_ptr<DescriptionItem> AutoPtr;

    public:
        DescriptionItem(
            const Oid& oid,
            const std::string& name = "",
            const std::string& des  = ""
        );

    public:
        // documentation from base class.
        Type type() const { return type_; }
        // documentation from base class.
        AutoPtr clone() const;

        std::auto_ptr<PersProductItem> crePersProductItem() const;

        ProductItem::CfgType canConfigure() const
        {
            return ProductItem::cfgNone;
        }

        ProductItem::DefPersType canDefPers() const
        {
            return ProductItem::defPersNone;
        }

        CfgPersType canPersonalize() const
        {
            return persNone;
        }

        const PersProductItem* defPersItem() const
        {
            return 0;
        }

    private:
        bool readSpecific(const OSB_DB::Session& session);
        bool insSpecific(const OSB_DB::Session& session);
        bool updSpecific(const OSB_DB::Session& session);
        bool delSpecific(const OSB_DB::Session& session);

        // Documentation from base class.
        ProductItem* clone_() const;
    };                                  // class DescriptionItem

    // *****************************************************************
    // class ProductItemTypes
    class ProductItemTypes {
    public:
        struct Info {
            typedef TypeId<ProductItemBase> PiType;
            PiType type_;
            std::string name_;
            std::string des_;
            bool isProductPart_;

            Info();
        };

        typedef std::vector<Info> List;
        typedef List::iterator Iterator;
        typedef List::const_iterator ConstIterator;
        typedef List::size_type SizeType;

        const List& list() const;


        Iterator begin();
        Iterator end();
        ConstIterator begin() const;
        ConstIterator end() const;
        SizeType size() const;
        void swap(List& other);

        long read(const OSB_DB::Session& session);

        const Info* find(TypeId<ProductItemBase> type) const;

        const Info& get(TypeId<ProductItemBase> type) const;

    private:
        List list_;
    };                                  // class ProductItemTypes
}                                       // namespace OSB_LIB

// ************************************************************************
// inline and template definitions
namespace OSB_LIB {

    // *****************************************************************
    // ProductItemBase
    template<typename P>
    P* ProductItemBase::isa(P*& ptr)
    {
        ptr = dynamic_cast<P*>(this);
        return ptr;
    }

    template<typename P>
    const P* ProductItemBase::isa(const P*& ptr) const
    {
        ptr = dynamic_cast<const P*>(this);
        return ptr;
    }
}                                       // namespace OSB_LIB
#endif                                  // #ifndef _PRODUCTITEM_H_

---