account.h

Go to the documentation of this file.

// OSB library ********************************************* -*- C++ -*-
/*
  AUTHOR(S): Ashwin Pakramzis (ap)
             Ramlan Rusdijanto (rr)

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

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

// + local headers
#include "osbid.h"
#include "chrono.h"
#include "money.h"

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

namespace OSB_LIB {
    class Associate;
    class InvoiceInfo;
    class Contract;
}

// *********************************************************************
// namespace extensions
namespace OSB_LIB {
    enum AccountType {Assets, Liabilities, Capital};

    struct Account {
        typedef Id<Account> Oid;        

        enum Side { credit, debit };
        static char toChar(Side sd);

        Account() {}
        Account(Oid oid, const std::string& ac, AccountType tp)
          : oid_(oid), code_(ac), type_(tp) {}

        Oid oid() const { return oid_; }

        Oid         oid_;               
        std::string code_;              
        AccountType type_;              
    };

    typedef std::map<std::string, Account> AccountList;

    class Transaction {
    public:
        Transaction() {}
        void setAccount(const Account& ac, const Money& m);

        Account account() const { return account_; }

        Money getAmount() const;

        Date          date_;     
        std::string   detail_;   
        std::string   folio_;    
    private:
        Account       account_;  
        Account::Side side_;     
        Money         amount_;   

    };

    typedef std::vector<Transaction> TransactionList;

    class SummaryCharges {
    public:
        SummaryCharges() {}
        void addTransaction(const Transaction& transaction)
        {
            transactions_.push_back(transaction);
        }

        void outstandingBalance(MoneyList& ml) const;
        void totalAmountDue(MoneyList& ml) const;

        typedef TransactionList::const_iterator TransactionListCI;
        TransactionListCI transactionsBegin() const
        {
            return transactions_.begin();
        }
        TransactionListCI transactionsEnd() const
        {
            return transactions_.end();
        }

        MoneyList balanceForward_;
        MoneyList currentCharges_;

    private:
        TransactionList transactions_;
    };                                  // class SummaryCharges

    class AccountInterface {
    public:
        virtual ~AccountInterface() {}
        virtual bool getBalance(
            const Associate& associate,
            const DateTime&  ts,
                  MoneyList& dest) = 0;
        virtual long readTransactions(TransactionList& transactions,
                                     const Associate& associate,
                                     const DateTime& start,
                                     const DateTime& end) = 0;

        virtual long getDuedays(
            const Associate& associate
        ) = 0;

        virtual long writeTransactions(
                           const TransactionList& transactions) = 0;
        virtual bool writeInvoice(
            const Associate&   associate,
            const Contract&    contract,
            const InvoiceInfo& invInfo
        ) = 0;
    };          // class AccountInterface

    class GlSummary {
    public:
        GlSummary() : sequenceNo_(0) {}
        void addAmount(
            const Account::Oid& accountCode,
                  Account::Side side,
            const Money&        amount
        );
        void post(const OSB_DB::Session& s);
        void clear();

    private:
        struct GlAmounts {
            MoneyList credit_;              
            MoneyList debit_;               
        };

        typedef std::map<Account::Oid, GlAmounts> GlSumBuf;

        GlSumBuf glSumBuf_;         
        long sequenceNo_;           
    }; // class GlSummary

    class AccountImp : public AccountInterface {
    public:
        AccountImp(OSB_DB::Session* s) : session_(s){}

        bool getBalance(
            const Associate& , // not used: associate,
            const DateTime&  , // not used: ts,
                  MoneyList&   // not used: dest
        )
        {
            return false;
        }

        virtual long readTransactions(
                  TransactionList& , // not used: transactions,
            const Associate&       , // not used: associate,
            const DateTime&        , // not used: start,
            const DateTime&          // not used: end
        )
        {
            // Add Sample Data to transactionList
            /*
             *  Currency::Oid currCode("EUR");
             *  Transaction transaction;
             *  transaction.date_ = Date(1, Aug, 2001);
             *  transaction.detail_ = "Payment by Credit Card";
             *  Account account;
             *  account.code_ = "xxxx";
             *  account.type_ = Assets;
             *  transaction.setAccount(account, Money(currCode, -500));
             *  transactions.push_back(transaction);
             *
             *  transaction.date_ = Date(2, Aug, 2001);
             *  transaction.detail_ = "Payment by Nets";
             *  transaction.setAccount(account, Money(currCode, -99));
             *  transactions.push_back(transaction);
             */
            return 0;
        }

        long writeTransactions(
            const TransactionList& // not used: transactions
        )
        {
            return 0;
        }
    private:
        OSB_DB::Session* session_;
    };                                  // class AccountImp

}                                       // namespace OSB_LIB
#endif                                  // #ifndef _ACCOUNT_H_

---