productpart.idl

Go to the documentation of this file.

// OSB library ********************************************* -*- C++ -*-
/*
  AUTHOR(S): Zhang Min (zm)
             Stephan Broennimann (vb)

  RCS information
   $Name: OSB_060808 $
   $Revision: 1.23.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 PRODUCTPART_IDL
#define PRODUCTPART_IDL
// *********************************************************************
#include "corba_utility.idl"

module corba {
  module pcat {
    module pp {
// *********************************************************************
// forward declaration of interfaces
        interface ProductPart;
        interface PpType;

        interface ProductPartWriter;

// *********************************************************************
// type definitions
        struct ProductPartId {
            long id;
        };

        struct PpTypeId {
            long id;
        };

        typedef sequence<ProductPart> ProductPartSeq;

        typedef sequence<PpType> PpTypeSeq;

// *********************************************************************
// interface definitions

        // *************************************************************
        // PpType
        interface PpType {
            readonly attribute PpTypeId id;
            readonly attribute common::Utf8String name;
            readonly attribute common::Utf8String desc;
            readonly attribute boolean isProductPart;



            const short piDescItem     = 1;
            const short piCallingCard  = 2;
            const short piService      = 3;
            const short piCredit       = 4;
            const short piTariffSystem = 5;
            const short piTrunkItem    = 6;
            const short piAnItem       = 7;
            const short piE164Item     = 8;
            const short piIp4Item      = 9;
            const short piIpGroup      = 10;
            const short piImsiItem     = 11;
            const short piPricelist    = 12;
            const short piDevice       = 20;
            const short piUimCard      = 21;
        };

        // *************************************************************
        // ProductPart
        enum PpCfgType {
            cfgNone,            
            cfgOptional,        
            cfgMandatory        
        };

        enum PpDefPersType {
             defPersNone,       
             defPersOptional,   
             defPersMandatory   
        };

        enum PpCfgPersType {
            persNone,           
            persOptional,       
            persMandatory       
        };

        interface ProductPart {

            PpTypeId tid()
                raises (common::OsbCorbaException);

            PpCfgType cfgType()
                raises (common::OsbCorbaException);

            PpDefPersType defPersType()
                raises (common::OsbCorbaException);

            ProductPartId id()
              raises (common::OsbCorbaException);

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

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

            long mandatory()
                raises (common::OsbCorbaException);

            PpCfgPersType canPersonalize()
                raises (common::OsbCorbaException);

            ProductPartId parentId()
                raises (common::OsbCorbaException);

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

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

            ProductPartSeq getParts()
                raises (common::OsbCorbaException);
        };

        // *************************************************************
        // ProductPartWriter
        interface ProductPartWriter : ProductPart {
            void setName(in common::Utf8String name)
                raises (common::OsbCorbaException);

            void setDesc(in common::Utf8String desc)
                raises (common::OsbCorbaException);

            void setMandatory(in long value)
                raises (common::OsbCorbaException);

            void setConfigDes(in common::Utf8String desc)
                raises (common::OsbCorbaException);

            void setDefPersDes(in common::Utf8String desc)
                raises (common::OsbCorbaException);

            ProductPartWriter addPart(in PpTypeId pptid)
               raises (common::OsbCorbaException);

            void removePart(in ProductPartId id)
                 raises (common::OsbCorbaException);
        };

        // *************************************************************
        // DescriptionPart
        interface DescriptionPart : ProductPart {
        };

        interface DescriptionPartWriter : ProductPartWriter,
                                          DescriptionPart
        {
        };

        // *************************************************************
        // TrunkPart
        interface TrunkPart : ProductPart {
        };

        interface TrunkPartWriter : ProductPartWriter,
                                    TrunkPart
        {
        };

        // *************************************************************
        // AnPart
        interface AnPart : ProductPart {
        };

        interface AnPartWriter : ProductPartWriter,
                                 AnPart
        {
        };

        // *************************************************************
        // E164Part
        interface E164Part : ProductPart {
        };

        interface E164PartWriter : ProductPartWriter,
                                   E164Part
        {
        };

        // *************************************************************
        // IpGroupPart
        interface IpGroupPart : ProductPart {
        };

        interface IpGroupPartWriter : ProductPartWriter,
                                      IpGroupPart
        {
        };
    };                                  // module pp
  };                                    // module pcat
};                                      // module corba
#endif                                  // PRODUCTPART_IDL

---