contract.h

Go to the documentation of this file.

// OSB library ********************************************* -*- C++ -*-
/*
  AUTHOR(S): Stephan Broennimann (vb)
             Lilian Qin Lan (lan)

  RCS information
   $Name: OSB_060808 $
   $Revision: 1.104 $

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

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

// + local headers
#include "money.h"
#include "osbid.h"           // Id template
#include "persproduct.h"     // list of personalized products
#include "statusrequest.h"

// *********************************************************************
// class declarations
namespace OSB_DB {
    class Session;
    class PersProductGw;
    class ContractGw;
}

namespace OSB_LIB {
    class RequestHandler;
    class Associate;
    class AnCList;
    class Billcycle;
    class OsbErrors;
    class TaxKey;
}

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

    class Contract {
        friend class OSB_DB::PersProductGw;
        friend class OSB_DB::ContractGw;
        friend class Associate;

        friend class RequestHandler;

        friend class AnCList;

    public:
        typedef Id<Contract> Oid;

        typedef Id<Associate> OwnerId;


        enum AccountingType {
            atCustomer = 'c',
            atSupplier = 's',
            atUnknown = '\0'
        };

        static AccountingType toAccountingType(char at);

        static char toChar(AccountingType at);

    public:
        inline explicit Contract(const Oid& oid = Oid());



        inline const Oid& oid() const;
        inline const Id<Associate>& ownerId() const;
        inline const DateTime& createdDate() const;
        inline const Id<TaxKey>& taxkey() const;
        inline const Id<Billcycle>& billcycleId() const;
        inline const Money& creditLimit() const;
        inline AccountingType accountingType() const;
        inline const Status& effStatus() const;
        inline const DateTime& effStatusDate() const;
        inline const Status& prefStatus() const;
        inline const DateTime& prefStatusDate() const;
        inline const PersProducts& products() const;
        inline long objVs() const;
        inline const StatusChanges& statusChanges() const;
        inline const StatusRequests& statusRequests() const;

        int buildPersParts();



        bool setTaxkey(const Id<TaxKey>& tkId)
        {
            taxkey_ = tkId;
            return true;
        }
        bool setBillCycle(const Id<Billcycle>& bcId)
        {
            billcycleId_ = bcId;
            return true;
        }
        bool setCreditLimit(const Money& credit)
        {
            creditLimit_ = credit;
            return true;
        }
        bool setAccountingType(AccountingType accountingType)
        {
            accountingType_ = accountingType;
            return true;
        }



        bool addPersProduct(
            OSB_DB::Session& session,
            PersProduct&     pp,
            bool             noWait
        );

        bool delPersProduct(
                  OSB_DB::Session&  session,
            const PersProduct::Oid& oid,
                  bool              noWait
        );

        const PersProduct* findPersProduct(
            const PersProduct::Oid& oid
        ) const;

        PersProduct* persProduct(const PersProduct::Oid& oid);

        const PersProduct& getPersProduct(
            const PersProduct::Oid& oid
        ) const;

        bool requestStatus(
            const OSB_DB::Session& session,
                  StatusRequest&   request,
                  OsbErrors&       errors,
                  bool             noWait
        );

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

        void readStatusChanges(
            const OSB_DB::Session& session,
            const Period&          period
        );

        void readStatusRequests(
            const OSB_DB::Session& session,
            const Period&          period
        );

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

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

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



        OsbError setPrefStatus(
            const OSB_DB::Session& session,
            const StatusRequest&   request
        );

        bool changeStatus(
            const OSB_DB::Session& session,
                  StatusChange&    change,
                  OsbErrors&       errors,
                  bool             noWait
        );

        bool applyChange(
            const OSB_DB::Session& session,
            const StatusChange&    change,
                  OsbErrors&       errors,
                  bool             noWait
        );



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

        static void lock(
            const OSB_DB::Session& session,
            const Contract::Oid&   id,
                  bool             noWait
        );

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

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

        bool delPp(
            const OSB_DB::Session&  session,
            const PersProduct::Oid& oid
        );

    private:
        Oid            oid_;
        OwnerId        ownerId_;
        DateTime       createdDate_;
        Id<TaxKey>     taxkey_;
        Id<Billcycle>  billcycleId_;
        Status         effStatus_;
        DateTime       effStatusDate_;
        Status         prefStatus_;
        DateTime       prefStatusDate_;
        long           objVs_;
        StatusChanges  chngs_;
        StatusRequests reqs_;
        PersProducts   products_;
        Money          creditLimit_;
        AccountingType accountingType_;
    };                                  // class Contract
}                                       // namespace OSB_LIB

// ************************************************************************
// inline definitions
namespace OSB_LIB {

    // ********************************************************************
    // class Contract
    inline Contract::Contract(const Oid& oid)
      : oid_(oid)
    {
        // empty
    }

    inline const Contract::Oid& Contract::oid() const
    {
        return oid_;
    }

    inline const Id<Associate>& Contract::ownerId() const
    {
        return ownerId_;
    }

    inline const DateTime& Contract::createdDate() const
    {
        return createdDate_;
    }

    inline const Id<TaxKey>& Contract::taxkey() const
    {
        return taxkey_;
    }

    inline const Id<Billcycle>& Contract::billcycleId() const
    {
        return billcycleId_;
    }

    inline const Money& Contract::creditLimit() const
    {
        return creditLimit_;
    }

    inline Contract::AccountingType Contract::accountingType() const
    {
        return accountingType_;
    }

    inline const Status& Contract::effStatus() const
    {
        return effStatus_;
    }

    inline const DateTime& Contract::effStatusDate() const
    {
        return effStatusDate_;
    }

    inline const Status& Contract::prefStatus() const
    {
        return prefStatus_;
    }

    inline const DateTime& Contract::prefStatusDate() const
    {
        return prefStatusDate_;
    }

    inline const PersProducts& Contract::products() const
    {
        return products_;
    }

    inline long Contract::objVs() const
    {
        return objVs_;
    }

    inline const StatusChanges& Contract::statusChanges() const
    {
        return chngs_;
    }

    inline const StatusRequests& Contract::statusRequests() const
    {
        return reqs_;
    }
}                                       // namespace VB
#endif                                  // #ifndef _CONTRACT_H_

---