trunkresource.h

Go to the documentation of this file.

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

  RCS information
   $Name: OSB_060808 $
   $Revision: 1.41 $

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

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

// + local headers
#include "osberror.h"
#include "resource.h"
#include "resourceitem.h"

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

namespace OSB_LIB {
    class TrunkGroup;
}

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

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

    // *****************************************************************
    // class TrunkResource
    class TrunkResource : public Resource {
        friend class OSB_DB::TrunkResourceGw;
    private:
        static const Type typeId_ = rtTrunkResource;

    public:
        struct AssignedTrunk {
            Id<TrunkGroup> trunkId_;
            DateTime       from_;
            DateTime       to_;
        };

        typedef std::list<AssignedTrunk> AssignedTrunks;

    public:

        class SameNetwork : public OsbException {
        public:
            SameNetwork(const TrunkResource& tr);
        };

        class TrunksAssigned : public OsbException {
        public:
            TrunksAssigned(const TrunkResource& tr);
        };

        class StatusIsAssigned : public OsbException {
        public:
            StatusIsAssigned(const TrunkResource& tr);
        };

    public:
        TrunkResource(const Oid& id = Oid());

        TrunkResource(
            const Number&       rn,
            const Id<Network>&  nw
        );



        Type typeId() const;
        const std::string& des() const;
        const Id<Network>& extNetwork() const;
        const AssignedTrunks& assignedTrks() const;
        const AssignedTrunks curAssignedTrks() const;
        bool canSetExtNw() const;

        const TrunkGroup& getTrkGroup(
            const Id<TrunkGroup>& tgId
        ) const;



        void setDes(const std::string& des);
        void setExternalNetwork(const Id<Network>& ext);


        bool read(const OSB_DB::Session& session);
        bool insert(const OSB_DB::Session& session);
        void updData(const OSB_DB::Session& session);
        bool remove(const OSB_DB::Session& session);
        bool addTrkGroup(
            const OSB_DB::Session& session,
            const Date&            start,
            const TrunkGroup&      tg
        );
        bool delTrkGroup(
            const OSB_DB::Session& session,
            const Id<TrunkGroup>&  tgId
        );

        bool isCurAssigned(const Id<TrunkGroup>& tgId) const;

        static void sortTgsByPriority(
            AssignedTrunks& groups
        );

        static void sortTgsByName(
            AssignedTrunks& groups
        );
    private:
        bool assign(const AssignedTrunk& assignedTg);
        bool deassign(const Id<TrunkGroup>& tgId);

    private:
        std::string des_;
        Id<Network> extNetworkId_;
        AssignedTrunks assignedTrunks_;
    };

    // *****************************************************************
    // class PersTrunk
    class PersTrunk : public PersResource {
    public:
        // Documentation from base class.
        typedef std::auto_ptr<PersTrunk> AutoPtr;

        static const Type type_;

    public:
        PersTrunk(const Oid& oid = Oid());
        PersTrunk(const PersTrunk& rhs);
        PersTrunk& operator=(const PersTrunk& rhs);
        ~PersTrunk();
    public:
        // Documentation from base class.
        virtual Type type() const;
        AutoPtr clone() const;
    private:
        // Documentation from base class.
        PersProductItem* clone_() const;

    public:
        virtual bool canConfig() const;

        virtual const Resource* resource() const;

        virtual const Resource* oldResource() const;

        void assign(const TrunkResource& trunkResource);
    private:
        virtual Resource* resource();
        virtual Resource* oldResource();
        virtual Resource* createResource(
            const Resource::Oid& resourceId
        );

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

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

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

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

    private:
        TrunkResource* trunkResource_;
        TrunkResource* oldTrunkResource_;
    };                                  // class PersTrunk

    // *****************************************************************
    // class TrunkItem
    class TrunkItem : public ResourceItem {
    public:
        static const Type type_;

        typedef std::auto_ptr<TrunkItem> AutoPtr;

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

    public:
        // Documentation from base class.
        virtual Type type() const;
        AutoPtr clone() const;

    public:
        ProductItem::CfgType canConfigure() const;

        ProductItem::DefPersType canDefPers() const;

        CfgPersType canPersonalize() const;

        const PersProductItem* defPersItem() const;

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

    private:
        ProductItem* clone_() const;


        virtual bool readSpecific(
            const OSB_DB::Session& session
        );
        virtual bool insSpecific(
            const OSB_DB::Session& session
        );
        virtual bool updSpecific(
            const OSB_DB::Session& session
        );
        virtual bool delSpecific(
            const OSB_DB::Session& session
        );
    };                                  // class TrunkItem

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

}                                       // namespace OSB_LIB
#endif                                  // #ifndef _TRUNKRESOURCE_H_

---