networkelement.idl

Go to the documentation of this file.

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

  RCS information
   $Name: OSB_060808 $
   $Revision: 1.12.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 NETWORKELEMENT_IDL
#define NETWORKELEMENT_IDL
// *********************************************************************
// included idl files
#include "tariffobject.idl"             // for ConnectionPtId
#include "trunkgroup.idl"

module corba {
    module nwmgr {
        module nwe {

            enum DialledNumType {
                incomingDialledNum, 
                outgoingDialledNum  
            };

            interface NetworkElement {
                NetworkElementId id()
                    raises (common::OsbCorbaException);

                common::Utf8String name()
                    raises (common::OsbCorbaException);

                common::Utf8String desc()
                    raises (common::OsbCorbaException);

                DialledNumType dialledType()
                    raises (common::OsbCorbaException);

                tcat::cp::ConnectionPtId connectionPt()
                    raises (common::OsbCorbaException);

                boolean hasNdc()
                    raises (common::OsbCorbaException);

                common::Utf8String ndc()
                    raises (common::OsbCorbaException);

                nwmgr::TimeZoneId tzId()
                    raises (common::OsbCorbaException);

                nwmgr::numanalyzer::NumberAnalyzer getNumberAnalyzer()
                    raises (common::OsbCorbaException);

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

                nwmgr::trk::TrunkGroupSeq getTrkGroups()
                    raises (common::OsbCorbaException);

                NetworkElementWriter getWriter()
                    raises (common::OsbCorbaException);

            };                          // interface NetworkElement

            interface NetworkElementWriter : NetworkElement {
                void setName(in common::Utf8String name);

                void setDesc(in common::Utf8String desc);

                void setDialledType(
                    in DialledNumType type);

                void setConnectionPt(
                    in tcat::cp::ConnectionPtId id
                );

                void setNdc(in common::Utf8String ndc);

                void unsetNdc();

                void setTimeZone(in nwmgr::TimeZoneId id);

                nwmgr::numanalyzer::NumberAnalyzerWriter
                    addNewNumberAnalyzer();

                void delNumberAnalyzer();

                nwmgr::numanalyzer::NumberAnalyzerWriter
                    getNumberAnalyzerWriter()
                        raises (common::OsbCorbaException);

                void saveNumberAnalyzer();

                void commitChanges(
                    in boolean noWait
                ) raises (common::OsbCorbaException);

            }; // interface NetworkElementWriter

        };                              // module nwe
    };                                  // module nwmgr
};                                      // module corab
#endif                                  // #ifndef NETWORKELEMENT_IDL

---