persproditem.idl

Go to the documentation of this file.

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

  RCS information
   $Name: OSB_060808 $
   $Revision: 1.26.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 PERSPRODITEM_IDL
#define PERSPRODITEM_IDL
// *********************************************************************
#include "productpart.idl"
#include "tariffobject.idl"
#include "cadmin.idl"

// ************************************************************************
// module extensions
module corba {
    module cadmin {
        module persproditem {

    // ********************************************************************
    // PersProdItemWriter
    interface PersProdItemWriter {
        readonly attribute PersItemId id;

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

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

        readonly attribute common::DateTime assignDate;

        readonly attribute common::DateTime deassignDate;

        readonly attribute pcat::pp::PpTypeId type;

        readonly attribute common::Utf8String personalization;

        readonly attribute boolean canConfig;

        PersItemId create(
            in boolean noWait
        ) raises (common::OsbCorbaException);

        PersItemId commitChanges(
            in boolean noWait
        ) raises (common::OsbCorbaException);
    };

    // ********************************************************************
    // Personalised tariff system
    interface PersTariffSystemWriter : PersProdItemWriter {
        tcat::ts::TariffSystem ts()
            raises (common::OsbCorbaException);

        tcat::ts::TariffSystemSeq tsList()
            raises (common::OsbCorbaException);

        void setTsId (in tcat::ts::TariffSystemId id)
            raises (common::OsbCorbaException);
    };

    // ********************************************************************
    // Personalised service
    interface PersServiceWriter : PersProdItemWriter {};

    // ********************************************************************
    // Personalised resource
    struct ResourceId {
        long id;
    };

    struct BasicResInfo {
        ResourceId id;

        common::Utf8String resourceNumber;
    };

    typedef sequence<BasicResInfo> BasicResSeq;

    interface PersResource : PersProdItemWriter {
        ResourceId rsId()
            raises (common::OsbCorbaException);
    };

    // ********************************************************************
    // E.164 number
    interface PersE164Writer : PersResource {
        BasicResInfo e164Number()
            raises (common::OsbCorbaException);

        BasicResSeq search(
            in common::Utf8String pattern,
            in long               numSearch
        ) raises (common::OsbCorbaException);

        boolean setE164Number(
            in ResourceId id
        ) raises (common::OsbCorbaException);
    };                                  // interface PersE164Writer

    // ********************************************************************
    // Calling card
/*
    interface PersCcWriter : PersResource {
        common::Utf8String serialNumber()
            raises (common::OsbCorbaException);
    };
*/

    // ********************************************************************
    // Personalised trunk
    struct TrunkGroupInfo {
        common::Utf8String name;
    };

    typedef sequence<TrunkGroupInfo> TrunkGroupInfoSeq;

    struct TrkResInfo {
        BasicResInfo resInfo;

        TrunkGroupInfoSeq trkGrps;
    };

    typedef sequence<TrkResInfo> TrkResInfoSeq;

    interface PersTrunkItemWriter : PersResource {
        TrkResInfo trkRes()
            raises (common::OsbCorbaException);

        TrkResInfoSeq trkResList()
            raises (common::OsbCorbaException);

        boolean setTrkRes(
            in ResourceId id
        ) raises (common::OsbCorbaException);
    };

    // ********************************************************************
    // Personalised IpGroup.
    struct IpGroupInfo {
        BasicResInfo resInfo;

        BasicResSeq ipAddresses;
    };

    typedef sequence<IpGroupInfo> IpGroupSeq;

    interface PersIpGroupItemWriter : PersResource {
        IpGroupInfo ipGroup()
            raises (common::OsbCorbaException);

        IpGroupSeq ipGroupList()
            raises (common::OsbCorbaException);

        boolean setIpGroup(
            in ResourceId id
        ) raises (common::OsbCorbaException);
    };

    // ********************************************************************
    // Personalised access number

    interface PersAnItemWriter : PersResource {
        BasicResInfo aNum()
            raises (common::OsbCorbaException);

        readonly attribute BasicResSeq anList;

        boolean setAn(
            in ResourceId id
        ) raises (common::OsbCorbaException);
    };

    // ********************************************************************
    // Personalised credit
/*
    interface PersCreditWriter : PersProdItemWriter {

        common::Money credit()
            raises (common::OsbCorbaException);
*/
/*
        boolean add(
            in common::Money amount,
            in boolean noWait
        ) raises (common::OsbCorbaException);
*/
// Use-case????
/*
        boolean deduct(
            in common::Money amount,
            in boolean noWait
        ) raises (common::OsbCorbaException);
    };
*/

        };           // module persproditem
    };               // module cadmin
};
#endif                                  // #ifndef PERSPRODITEM_IDL

---