resource.idl

Go to the documentation of this file.

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

  RCS information
   $Name: OSB_060808 $
   $Revision: 1.15.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 RESOURCE_IDL
#define RESOURCE_IDL

// *********************************************************************
// included idl files
#include "corba_utility.idl"
#include "nmanager.idl"
#include "inventorypool.idl"
#include "resfwd.idl"

module corba {
  module res {

    struct ResourceTypeId {
        long id;
    };

    interface Resource {
        ResourceTypeId type()
            raises (common::OsbCorbaException);

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

        imgmt::PoolId poolId()
            raises (common::OsbCorbaException);

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

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

        ResourceStatus status()
            raises (common::OsbCorbaException);

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

        common::Date quarantineEnd()
            raises (common::OsbCorbaException);

        nwmgr::nw::NetworkId networkId()
            raises (common::OsbCorbaException);

        nwmgr::nwe::NetworkElementId networkElementId()
            raises (common::OsbCorbaException);

        common::Date assigned()
            raises (common::OsbCorbaException);

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

        boolean canDel()
            raises (common::OsbCorbaException);
    };                          // interface Resource

    interface ResourceWriter : Resource {
        void setPool(
            in imgmt::PoolId poolId
        ) raises (common::OsbCorbaException);
        void setStatus(
            in ResourceStatus newStatus
        ) raises (common::OsbCorbaException);

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

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

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

        void destroy();
    };                                  // interface ResourceWriter
  };                                    // module res
};                                      // module corba
#endif                                  // #ifndef RESOURCE_IDL

---