productcat.h

Go to the documentation of this file.

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

  RCS information
   $Name: OSB_060808 $
   $Revision: 1.38 $

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

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

// + local headers
#include "mutex.h"
#include "pricelist.h"
#include "product.h"
#include "productitem.h"

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

// *********************************************************************
// class declarations
    class PcatLockMgr;
    class PcatMgr;

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

    // *****************************************************************
    // class ProductCatalogue

    class ProductCatalogue {
        friend class PcatLockMgr;
        friend class PcatMgr;

    private:
        ProductCatalogue();
        ~ProductCatalogue();

    public:
        // *************************************************************
        // Init methods

        void read(const OSB_DB::Session&);

        PcatLockMgr& lockMgr();

        std::ostream& prInfo(std::ostream&);

        // *************************************************************
        // Product maintenance

    private:


        void addProduct(
            OSB_DB::Session& session,
            Product&         pd
        );

        void updProduct(
            OSB_DB::Session& session,
            Product&         pd
        );

    public:


        void saveProduct(
            OSB_DB::Session& session,
            Product&         pd
        );

        void delProduct(
                  OSB_DB::Session& session,
            const Product::Oid&    pdId
        );

        const Product* findProduct(const Product::Oid& pdId) const;

        const Products& products() const { return products_; }

        void sortProdByName(bool desc = false);

        // *************************************************************
        // Pricelist maintenance



        const Pricelist* findPricelist(const Pricelist::Oid&) const;

        const Pricelist& getPricelist(const Pricelist::Oid&) const;

        Pricelist* pricelist(const Pricelist::Oid&);

        const Pricelists&
            pricelists() const { return pricelists_; }

        bool addPricelist(
            OSB_DB::Session& session,
            Pricelist&       pl);

        bool updPricelist(
            OSB_DB::Session& session,
            Pricelist&       pl);

        bool delPricelist(
            OSB_DB::Session& session,
            Pricelist::Oid&  pl);

        void sortPricelistByName(bool desc = false);

        const PricelistCfg* findPricelistCfg(
            const Pricelist::Oid& oid,
            const DateTime&       refDate
        ) const;

        const PricelistCfg* findPricelistCfg(
            const PricelistCfg::Oid&
        ) const;

        const PricelistCfg& getPricelistCfg(
            const PricelistCfg::Oid&
        ) const;

        PricelistCfg* pricelistCfg(const PricelistCfg::Oid&);

        const PricelistCfgs&
            pricelistCfgs() const { return pricelistCfgs_; }

        bool addPricelistCfg(
            OSB_DB::Session& session,
            PricelistCfg&    plCfg);

        bool updPricelistCfg(
            OSB_DB::Session& session,
            PricelistCfg&    plCfg);

        bool delPricelistCfg(
            OSB_DB::Session&   session,
            PricelistCfg::Oid& plCfg);

        bool checkPricelistCfg(
            OSB_DB::Session&   session,
            PricelistCfg::Oid& plCfg);

        bool releasePricelistCfg(
            OSB_DB::Session&   session,
            PricelistCfg::Oid& plCfg);

        bool revokePricelistCfg(
            OSB_DB::Session&   session,
            PricelistCfg::Oid& plCfg);

        bool unfreezePricelistCfg(
            OSB_DB::Session&   session,
            PricelistCfg::Oid& plCfg);

        // *************************************************************
        // Subscription functions maintenance



        const SubsFuncCfgs&
            subsFuncCfgs() const { return subsFuncCfgs_; }

        const SubsFuncCfg* findSubsFuncCfg(
            const SubsFuncCfg::Oid&) const;

        // *************************************************************
        // Read access to product item types
    private:
        typedef TypeId<ProductItemBase> PiType;

    public:


        const ProductItemTypes& piTypes() const { return piTypes_; }

        const ProductItemTypes::Info& piType(
            const PiType& type
        ) const;

    private:
        ProductCatalogue(const ProductCatalogue& rhs);
        ProductCatalogue& operator=(const ProductCatalogue& rhs);



        Product* product(const Product::Oid& productId);

        void buildNodeTree(const OSB_DB::Session& session);
        int setPlSubsFunc();

    private:
        Products products_;
        Pricelists pricelists_;
        PricelistCfgs pricelistCfgs_;
        SubsFuncCfgs subsFuncCfgs_;

        ProductItemTypes piTypes_;

        PcatLockMgr*   pcatLm_;
    };                                  // class ProductCatalogue

    // *****************************************************************
    // PcatMgr
    class PcatMgr {
    public:
        static ProductCatalogue& pcat();

    private:
        PcatMgr();
        PcatMgr(const PcatMgr&);

        static ProductCatalogue* pcat_;
    };

    // *****************************************************************
    // class PcatLockMgr
    class PcatLockMgr {
        friend class ProductCatalogue;

    public:

        typedef ReadGuard<Product*> ProductRg;
        typedef ReadGuard<Products*> ProductsRg;
        typedef ReadGuard<Pricelist*> PricelistRg;
        typedef ReadGuard<Pricelists*> PricelistsRg;

        typedef ReadGuard<ProductNode*> ProductNodeRg;

        typedef WriteGuard<Pricelists*> PricelistsWg;

        typedef RwGuard ProductsWg;

        enum Status {
            success        = 0,
            lockFailed     = 1,         
            objectNotFound = 2,         
            wrongPiType    = 3          
        };

    public:
        PcatLockMgr(ProductCatalogue& pcat);

    public:
        ProductRg readLock(const Product::Oid& id);
        ProductsRg readLockPds();
        ProductNodeRg readLock(
            const Product::Oid&     pdId,
            const ProductNode::Oid& pnId
        );

        PricelistRg readLock(const Pricelist::Oid& id);
        PricelistsRg readLockPls();

    private:
        ProductsWg writeLockPds();

        PricelistsWg writeLockPls();
    private:
        ProductCatalogue& pcat_;
        RwMutex pdMutex_;
        RwMutex plMutex_;
    };
}                                       // namespace OSB_LIB
#endif                                  // #ifndef _PRODUCTCAT_H_

---