taxkey.h

Go to the documentation of this file.

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

  RCS information
   $Name: OSB_060808 $
   $Revision: 1.16 $

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

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

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


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

// *********************************************************************
// namespace extensions
namespace OSB_LIB {
    enum TaxKeyType {
        tktUnknown   = '\0',
        tktAssociate = 'a',
        tktContract  = 'c',
        tktProduct   = 'p'
    };

    char toChar(TaxKeyType tkt);

    TaxKeyType toTaxKeyType(char c);

    class TaxKey {
        friend class OSB_DB::TaxKeyGw;
    public:
        typedef Id<TaxKey> Oid;

        TaxKey(Oid oid = Oid(ID_NOT_SET)): oid_(oid) {}

        TaxKey(const Oid&         oid,
               const std::string& name,
               const TaxKeyType   tkt,
               bool               wildCard = false
               ): oid_(oid), name_(name), type_(tkt),
                  wildCard_(wildCard) {}


        const Oid& oid() const { return oid_; }
        const std::string& name() const { return name_; }
        const TaxKeyType& type() const { return type_; }
        bool wildCard() const { return wildCard_; }

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

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

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

    private:
        Oid         oid_;              
        std::string name_;             
        TaxKeyType  type_;             

        bool        wildCard_;

    };

    class TaxKeyList {
    public:


        typedef std::vector<TaxKey> List;
        typedef List AssociateList;
        typedef List ContractList;
        typedef List ProductList;

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

        const List& get(const TaxKeyType tkt) const;

        TaxKey::Oid getTaxKeyByName(const std::string& name) const;

        const TaxKey& getTaxKey(const TaxKey::Oid& oid) const;

        const TaxKey* findTaxKey(const TaxKey::Oid& oid) const;

        void add(const TaxKey& tk);

        long size() const;

    private:
        AssociateList aList_; 
        ContractList  cList_; 
        ProductList   pList_; 
    };
}                                       // namespace OSB_LIB
#endif                                  // #ifndef _TAXKEY_H_

---