networkmanager.idl

Go to the documentation of this file.

// OSB library ************************************************ -*- IDL -*-
/*
  AUTHOR(S): Huang Yong Feng (hyf)

  RCS information
   $Name: OSB_060808 $
   $Revision: 1.30.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 NETWORKMANAGER_IDL
#define NETWORKMANAGER_IDL
// ************************************************************************
// included IDLs
#include "network.idl"
#include "inventorypool.idl"
#include "resfwd.idl"
#include "corba_utility.idl"

// ************************************************************************
// interface declarations
module corba {
  module imgmt {
    interface DvcRsrcMgr;
  };
};

// ************************************************************************
// module extensions
module corba {
  module nwmgr {

    // forward declarations
    interface NetworkElementMgr;
    interface TrunkGroupMgr;

    interface NetworkManager
    {
        readonly attribute common::ServerInfo getServerInfo;
        void ping();



        nwmgr::nw::Network getNetwork(
            in nwmgr::nw::NetworkId id
        ) raises (common::OsbCorbaException);

        nwmgr::nw::NetworkSeq getNetworks()
            raises (common::OsbCorbaException);

        nwmgr::nw::Network creNetwork(
            in common::Utf8String name,
            in common::Utf8String desc,
            in nwmgr::TimeZoneId  tzId,
            in boolean            noWait
        ) raises (common::OsbCorbaException);

        void delNetwork(
            in nwmgr::nw::NetworkId id,
            in boolean              noWait
        ) raises (common::OsbCorbaException);



        imgmt::Pools inventoryPools(
            in boolean forceRead
        ) raises (common::OsbCorbaException);

        imgmt::PoolId savePool(
            inout imgmt::Pool pool,
            in    boolean     noWait
        ) raises (common::OsbCorbaException);



        imgmt::DvcRsrcMgr mkDvcRsrcMgr();



        res::TrunkResource getTr(
            in res::ResourceId id
        ) raises (common::OsbCorbaException);

        res::TrunkResourceSeq getTrs()
            raises (common::OsbCorbaException);

        res::TrunkResourceSeq getTrsOfNetwork(
            in nwmgr::nw::NetworkId id
        ) raises (common::OsbCorbaException);

        res::TrunkResourceWriter creNewTr(
            in common::Utf8String   rn,
            in nwmgr::nw::NetworkId nwId
        );

        void delTr(
            in res::ResourceId id,
            in boolean         noWait
        ) raises (common::OsbCorbaException);



        res::AccessNumber getAn(
            in res::ResourceId id
        ) raises (common::OsbCorbaException);

        res::AccessNumberSeq getAns()
            raises (common::OsbCorbaException);

        res::AccessNumberSeq getAnsOfNetwork(
            in nwmgr::nw::NetworkId id
        ) raises (common::OsbCorbaException);

        res::AccessNumberWriter creNewAn(
            in common::Utf8String   rn,
            in nwmgr::nw::NetworkId nwId
        );

        void delAn(
            in res::ResourceId id,
            in boolean         noWait
        ) raises (common::OsbCorbaException);



        res::E164Resource getE164(
            in res::ResourceId id
        ) raises (common::OsbCorbaException);

        res::E164ResourceSeq searchE164s(
            in res::ResourceStatus status,
            in common::Utf8String  pattern,
            in long                maxNum
        ) raises (common::OsbCorbaException);

        res::E164ResourceSeq createE164s(
            in nwmgr::nwe::NetworkElementId neId,
            in common::Utf8String           ccNdc,
            in common::Utf8String           first,
            in long                         qnty
        ) raises (common::OsbCorbaException);

        void delE164(
            in res::ResourceId id,
            in boolean         noWait
        ) raises (common::OsbCorbaException);



        tcat::cp::ConnectionPt getConnectionPt(
            in tcat::cp::ConnectionPtId cpId
        ) raises (common::OsbCorbaException);

        tcat::cp::ConnectionPtSeq getConnectionPts();



        TimeZone getTimeZone(
            in nwmgr::TimeZoneId id
        ) raises (common::OsbCorbaException);

        TimeZoneSeq getTimeZones()
            raises (common::OsbCorbaException);



        res::Ip4Address getIp4(
            in res::ResourceId id
        ) raises (common::OsbCorbaException);

        res::Ip4AddressSeq getIp4s()
            raises (common::OsbCorbaException);

        res::Ip4AddressSeq getIp4sOfNetwork(
            in nwmgr::nw::NetworkId id
        ) raises (common::OsbCorbaException);

        res::Ip4AddressWriter creNewIp4(
            in common::Utf8String   rn,
            in nwmgr::nw::NetworkId nwId
        );

        void delIp4(
            in res::ResourceId id,
            in boolean                noWait
        ) raises (common::OsbCorbaException);



        res::IpGroup getIpg(
            in res::ResourceId id
        ) raises (common::OsbCorbaException);

        res::IpGroupSeq getIpgs()
            raises (common::OsbCorbaException);

        res::IpGroupSeq getIpgsOfNetwork(
            in nwmgr::nw::NetworkId id
        ) raises (common::OsbCorbaException);

        res::IpGroupWriter creNewIpg(
            in common::Utf8String   rn,
            in nwmgr::nw::NetworkId nwId
        );

        void delIpg(
            in res::ResourceId id,
            in boolean         noWait
        ) raises (common::OsbCorbaException);

        NetworkElementMgr getNetworkElementMgr();

        TrunkGroupMgr getTrunkGroupMgr();

    };                              // interface NetworkManager

    interface NetworkElementMgr
    {
        nwmgr::nwe::NetworkElementWriter creNewElement(
            in nwmgr::nw::NetworkId id
        ) raises (common::OsbCorbaException);

        //void addElement(
        //    in nwe::NetworkElementWriter writer
        //) raises (common::OsbCorbaException);

        void delElement(
            in nwmgr::nwe::NetworkElementId id,
            in boolean                      noWait
        ) raises (common::OsbCorbaException);

    };                              // interface NetworkElementMgr

    interface TrunkGroupMgr
    {
        nwmgr::trk::TrunkGroup getTrkGroup(
            in nwmgr::trk::TrunkGroupId id
        ) raises (common::OsbCorbaException);

        nwmgr::trk::TrunkGroupWriter creNewTrkGroup(
            in nwmgr::nwe::NetworkElementId id
        ) raises (common::OsbCorbaException);

        //void addTrkGroup(
        //    in trk::TrunkGroupWriter writer
        //) raises (common::OsbCorbaException);

        void delTrkGroup(
            in nwmgr::nwe::NetworkElementId eid,
            in nwmgr::trk::TrunkGroupId     tid,
            in boolean                      noWait
        ) raises (common::OsbCorbaException);

      };                                // interface TrunkGroupMgr
  };                                    // module nwmgr
};                                      // module corba
#endif                                  // NERWORKMANAGER_IDL

---