resource.h

Go to the documentation of this file.

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

  RCS information
   $Name: OSB_060808 $
   $Revision: 1.92.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 _RESOURCE_H_
#define _RESOURCE_H_

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

// + local headers
#include "chrono.h"
#include "osbid.h"
#include "osbconst.h"
#include "resourcefwd.h"

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

namespace OSB_LIB {
    class Device;
    class InventoryPool;
    class OsbError;
    class PersResource;
    class Status;
}

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

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

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

    // *****************************************************************
    // class Resource
    class Resource {
        friend class OSB_DB::ResourceGw;

        friend class PersResource;
        friend class Device;
    public:                             // type definitions
        typedef Id<Resource> Oid;
        typedef ResourceType Type;
        typedef ResourceNumber Number;

        enum Status {
            rsUnknown = '\0',
            rsCreated    = 'c',
            rsAvailable  = 'v',
            rsAssigned   = 'a',
            rsQuarantine  = 'q',
            rsDeactivated = 'd',
            rsLinked = 'l'
        };

    public:                             // construction, destruction

        explicit Resource(const Oid& oid = Oid());
        explicit Resource(
            const Number&      rn,
            const Id<Network>& nw = Id<Network>()
        );
        Resource(
            const Number&              rn,
            const Id2<NetworkElement>& ne
        );

        virtual ~Resource();

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

    public:


        virtual Type typeId() const = 0;

        const Oid& oid() const;

        long objVs() const;

        bool isPrepaid() const;

        const Number& resourceNumber() const;

        const Status status() const;

        const Date& quarantineEnd() const;

        const Date& assigned() const;

        const Id<Network> nwId() const;

        const Id2<NetworkElement>& neId() const;

        const Id<Device> deviceId() const;

        const Id<InventoryPool> poolId() const;

        bool canDel() const;

        virtual bool isAvailable() const;

        virtual bool canUpd() const;

        virtual void setStatus(
            const Status newStatus
        );

        void setPool(
            const Id<InventoryPool>& poolId
        );

        void setDevice(
            const Id<Device>& deviceId
        );

    protected:
        virtual void setAssigned();

        virtual void setDeassigned();

        virtual void setAvailable();

    protected:
        bool assignResource(const OSB_DB::Session& session);

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

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

    public:
        void updStatus(
            const OSB_DB::Session& session,
                  bool             isLocked
        );

        virtual bool read(const OSB_DB::Session& session) = 0;
        virtual bool insert(const OSB_DB::Session& session) = 0;
        virtual void updData(const OSB_DB::Session& session) = 0;
        virtual bool remove(const OSB_DB::Session& session) = 0;

    protected:


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

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

        void updDataBase(const OSB_DB::Session& session);

        void updAssigned(
            const OSB_DB::Session& session,
            const DateTime&        firstAss
        );

        bool removeBase(
            const OSB_DB::Session& session,
                  bool             isLocked
        );

        void lock(
            const OSB_DB::Session& session,
                  bool             noWait
        ) const;

        static void handleObjectStatus(
                  ObjectStatus os,
            const Oid&         id
        );

        void incObjVs(
            const OSB_DB::Session& session
        );

        OSB_LIB::Status getPersResourceStatus(
            const OSB_DB::Session& session,
            const DateTime&        ts = DateTime::now()
        ) const;

    private:
        Oid oid_;
        long objVs_;
        Status status_;
        Date quarantineEnd_;
        Date assigned_;

        Id<Device> deviceId_;
        Id<InventoryPool> poolId_;

    protected:
        Number resourceNumber_;
        Id2<NetworkElement> neId_;
        bool prepaid_;
    };                                  // class Resource
}                                       // namespace OSB_LIB
#endif                                  // #ifndef _RESOURCE_H_

---