associate_i.h

Go to the documentation of this file.

// OSB library ********************************************* -*- C++ -*-
/*
  AUTHOR(S): Darryl Kang (dk)

  RCS information
   $Name: OSB_060808 $
   $Revision: 1.55 $

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

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

// + libraries
#include "associate.h"

// + local headers
#include "associateS.h"
#include "servantlocators.h"

// + class declarations
namespace OSB_LIB {
    class Contract;
}
namespace OSB_CORBA {
    class AddressWriter_i;
    class AnCList_i;
}

// ************************************************************************
// namespace extensions
namespace OSB_CORBA {
    using namespace corba::cadmin::addr;
    using namespace corba::cadmin::assoc;
    using namespace corba::cadmin::contract;

    using corba::cadmin::AssociateId;
    using corba::cadmin::Status;
    using corba::cadmin::StatusHistory;
    using corba::cadmin::StatusRequest;
    using corba::cadmin::StatusValue;
    using corba::common::Account;
    using corba::common::CfgErrorSeq_out;
    using corba::common::DateTime;
    using corba::common::TaxKeyId;
    using corba::common::Utf8String;

    class AssociateWriter_i :
        public virtual POA_corba::cadmin::assoc::AssociateWriter
    {
    public :

        static const std::string IFC;

        AssociateWriter_i(
                  AnCList_i&          anclist,
            const OSB_LIB::Associate& assoc
        );

        virtual ~AssociateWriter_i();

        const Locators::Key& key() const
        {
            return key_;
        }

        virtual AssociateId id()
            throw (CORBA::SystemException);

        virtual Utf8String* name()
            throw (CORBA::SystemException);

        virtual AssociateId parentId()
            throw (CORBA::SystemException);

        virtual CORBA::ULong levelId()
            throw (CORBA::SystemException);

        virtual AssociateType asType()
            throw (CORBA::SystemException);

        virtual AssociateIdSeq* getChildren()
            throw (CORBA::SystemException);

        virtual TaxKeyId tkId()
            throw (CORBA::SystemException);

        virtual AddressWriter_ptr getAddress(
            const AddrTypeId& addr
        ) throw (CORBA::SystemException, OsbCorbaException);

        virtual AddressSeq* getAddresses()
            throw (CORBA::SystemException, OsbCorbaException);

        virtual ContractIdSeq* getContractIds()
            throw (CORBA::SystemException);

        virtual Status effStatus()
            throw (CORBA::SystemException);

        virtual Status prefStatus()
            throw (CORBA::SystemException);

        virtual DateTime* effStatusDate()
            throw (CORBA::SystemException);

        virtual DateTime* prefStatusDate()
            throw (CORBA::SystemException);

        virtual StatusValue requestedStatus(
            const DateTime& ts
        ) throw (CORBA::SystemException, OsbCorbaException);

        StatusHistory* statusHistory(
            const DateTime& from,
            const DateTime& to,
            CORBA::Boolean  noWait
        ) throw (CORBA::SystemException, OsbCorbaException);

        virtual Account* salesLedger()
            throw (CORBA::SystemException);

        virtual Account* purchaseLedger()
            throw (CORBA::SystemException);

        virtual Utf8String* accNo()
            throw (CORBA::SystemException);

        virtual CORBA::Boolean addChild(
            const AssociateId& id,
            CORBA::Boolean     noWait
        ) throw (CORBA::SystemException, OsbCorbaException);

        virtual CORBA::Boolean removeChild(
            const AssociateId& id,
            CORBA::Boolean     noWait
        ) throw (CORBA::SystemException, OsbCorbaException);

        virtual void setTaxKey(
            const TaxKeyId& id
        ) throw (CORBA::SystemException);

        AddressWriter_ptr getNewAddress(
            const AddrTypeIdSeq& types
        ) throw (CORBA::SystemException, OsbCorbaException);

        CORBA::Boolean removeAddress(
            const AddrTypeId& type,
            CORBA::Boolean noWait,
            CfgErrorSeq_out errors
        ) throw (CORBA::SystemException, OsbCorbaException);

        CORBA::Boolean linkAddressType(
            const AddrTypeId& type,
            const AddrTypeId& newType,
            CORBA::Boolean    noWait
        ) throw (CORBA::SystemException, OsbCorbaException);

        CORBA::Boolean unlinkAddressType(
            const AddrTypeId& type,
            CORBA::Boolean noWait
        ) throw (CORBA::SystemException, OsbCorbaException);

        virtual void setSalesLedger(
            const Account& salesLedger
        ) throw (CORBA::SystemException);

        virtual void setPurchaseLedger(
            const Account& purchaseLedger
        ) throw (CORBA::SystemException);

        virtual void setName(
            const Utf8String& name
        ) throw (CORBA::SystemException);

        virtual void setAccountNo(
            const Utf8String& accNo
        ) throw (CORBA::SystemException);

        virtual AssociateId create(
            CORBA::Boolean noWait
        ) throw (CORBA::SystemException, OsbCorbaException);

        virtual CORBA::Boolean commitChanges(
            CORBA::Boolean noWait
        ) throw (CORBA::SystemException, OsbCorbaException);



        CORBA::Boolean changeStatus (
            StatusRequest&  status,
            CORBA::Boolean  noWait,
            CfgErrorSeq_out errors
        ) throw (CORBA::SystemException, OsbCorbaException);

        void checkRefUsage() throw (OsbCorbaException);

    private:
        typedef std::list<Locators::Key> Servants;

        AnCList_i& ancList_;
        OSB_LIB::Associate* assoc_;
        Locators::Key key_;

        Servants addrList_;
    };

    class CustomerWriter_i :
        public virtual POA_corba::cadmin::assoc::CustomerWriter,
        public virtual AssociateWriter_i
    {
    public :

        static const std::string IFC;

        // Constructor
        CustomerWriter_i(
                  AnCList_i&          anclist,
            const OSB_LIB::Associate& assoc
        ) : AssociateWriter_i(anclist, assoc)
        {
            // empty body
        };
    };

    class AssociateServantFactory {
    public :
        AssociateWriter_i* makeAssociateWriter(
                  AnCList_i&          anclist,
            const OSB_LIB::Associate& assoc
        ) throw (OsbCorbaException);
    };

    OSB_LIB::Associate::Type assocType(const AssociateType type);

    AssociateType assocType(const OSB_LIB::Associate::Type type);

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

}   // namespace OSB_CORBA

#endif                                 // #ifndef _ASSOCIATE_I_H_

---