managedelementmanager.idl

UCS (Ultra Corba Simulator) is one more powerful corba client/servant simulator tool than other simi

#ifndef managedElementManager_idl
#define managedElementManager_idl

// ********************************
// *                              *
// * managedElementManager.idl    *
// *                              *
// ********************************

//Include list
#include "globaldefs.idl"
#include "common.idl"
#include "managedElement.idl"
#include "transmissionParameters.idl"
#include "terminationPoint.idl"
#include "notifications.idl"
#include "subnetworkConnection.idl"

#pragma prefix "mtnm.tmforum.org"

  /** 
   * <a href=supportingDocumentation/overview.html>Overview of NML-EML interface</a>
   *
   * <p>This module contains the definition of the managed element manager
   * of the NML-EML interface.</p>
   *
   * <h5> Version 2.0. </h5>
   **/


module managedElementManager
{
 

  /**
   * <p>The managedElementManager is used to gain access to operations
   * which deal with managed elements and termination points.</p>
   *
   * <p>A handle to an instance of this interface is gained via the
   * <a href=_emsSession.EmsSession_I.html#emsSession::EmsSession_I::getManager>
   * getManager</a> operation in Manager.</p>
   **/

  interface ManagedElementMgr_I : common::Common_I
    {

  /**
   * <p>This allows an NMS to request details of all of the Managed Elements that
   * are under the control of this ManagedElementMgr_I.</p>
   * 
   * <p>In order to allow the NMS to deal with a large number of objects,
   * this operation uses an iterator. See
   * <a href=supportingDocumentation/iterators.html>iterator overview</a>
   * for information on how iterators are used in this interface.</p>
   * 
   * @parm  unsigned long how_many: Maximum number of MEs to report in the first batch.
   * @parm  ManagedElementList_T meList: First batch of MEs.
   * @parm  managedElement::ManagedElementIterator_I meIt: Iterator to retrieve the remaining MEs.
   * @raises globaldefs::ProcessingFailureException<dir>
   * EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure<br>
   * EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when maximum number of iterators that the EMS
   *  can support has been reached.</dir>
   **/
      void getAllManagedElements(
            in unsigned long how_many,
            out managedElement::ManagedElementList_T meList,
            out managedElement::ManagedElementIterator_I meIt) 
               raises(globaldefs::ProcessingFailureException);


  /**
   * <p>This operation has exactly the same behaviour as 
   * <a href=_managedElementManager.ManagedElementMgr_I.html#managedElementManager::ManagedElementMgr_I::getAllManagedElements>getAllManagedElements</a>, but
   * instead of returning the entire object structures, this operation returns their names.</p>
   * 
   * <p>In order to allow the NMS to deal with a large number of objects,
   * this operation uses an iterator. See
   * <a href=supportingDocumentation/iterators.html>iterator overview</a>
   * for information on how iterators are used in this interface.</p>
   * 
   * @parm  unsigned long how_many: Maximum number of ME names to return in the first batch.
   * @parm  globaldefs::NamingAttributesList_T nameList: First batch of ME names.
   * @parm  globaldefs::NamingAttributesListIterator_I nameIt: Iterator to retrieve remaining
   * ME names.
   * @raises globaldefs::ProcessingFailureException
   * As for <a href=_managedElementManager.ManagedElementMgr_I.html#managedElementManager::ManagedElementMgr_I::getAllManagedElements>getAllManagedElements</a>
   **/
   void getAllManagedElementNames(
         in unsigned long how_many,
         out globaldefs::NamingAttributesList_T nameList,
         out globaldefs::NamingAttributesIterator_I nameIt)
         raises(globaldefs::ProcessingFailureException);

  /** 
   * <p>This service returns the list of subnetwork names that the  
   * Managed Element supplied as an input parameter belongs to.<p>
   * @parm globaldefs::NamingAttributes managedElementName: The name of the managed element
   * for which to retrieve the containing subnetwork names. 
   * @parm globaldefs::NamingAttributesList_T subnetNames: The names of the subnetworks
   * this NE belongs to.
   * @raises globaldefs::ProcessingFailureException<dir>
   * EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure<br>
   * EXCPT_INVALID_INPUT - Raised when managedElementName does not reference a managed
   *  element object<br>
   * EXCPT_ENTITY_NOT_FOUND - Raised when managedElementName references an ME object
   *  that does not exist<br>
   * EXCPT_NE_COMM_LOSS - Raised when communications to managedElement is lost<br>
   * </dir>
   **/
   void getContainingSubnetworkNames(
         in globaldefs::NamingAttributes_T managedElementName,
         out globaldefs::NamingAttributesList_T subnetNames)
         raises (globaldefs::ProcessingFailureException);

  /**
   * <p>This allows an NMS to request all of the PTPs on the specified  
   * Managed Element, that contain one or more of the NMS-specified PTP layer rates, 
   * and that are capable of supporting one or more of the NMS-specified
   * connection layer rates.
   * If there are no PTPs that match the layer constraints, an empty 
   * list is returned. A PTP will be returned regardless
   * of connectivity to other managed elements and regardless of position
   * in the subnetwork (both edgepoints of the subnetwork and the PTPs
   * that are internal to the subnetwork are reported).</p>
   * 
   * <p>In order to allow the NMS to deal with a large number of objects,
   * this operation uses an iterator. See
   * <a href=supportingDocumentation/iterators.html>iterator overview</a>
   * for information on how iterators are used in this interface.</p>
   * 
   * @parm globaldefs::NamingAttributes_T managedElementName: The name of the 
   * Managed Element for which to retrieve PTPs.
   * @parm transmissionParameters::LayerRateList_T tpLayerRateList: List of PTP layer rates
   * for which the PTPs are to be fetched. A PTP must contain at least one of the
   * layer rates specified to be reported.  If the list is empty then all PTPs (of all rates)
   * are returned.
   * @parm transmissionParameters::LayerRateList_T connectionLayerRateList: List of connection 
   * layer rates for which the PTPs are to be fetched. A PTP must support connections for at 
   * least one of the
   * layer rates specified to be reported.  If the list is empty then all PTPs (for all 
   * connection rates) are returned.
   * @parm  unsigned long how_many: Maximum number of PTPs to report in the first batch.
   * @parm  terminationPoint::TerminationPointList_T tpList: First batch of PTPs.
   * @parm  terminationPoint::TerminationPointIterator_I tpIt: Iterator to retrieve remaining PTPs.
   * @raises globaldefs::ProcessingFailureException<dir>
   * EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure<br>
   * EXCPT_INVALID_INPUT - Raised when managedElementName does not reference a managed element
   *  object, or tpLayerRateList or connectionLayerRateList contain undefined rates<br>
   * EXCPT_ENTITY_NOT_FOUND - Raised when managedElementName references an ME object 
   *  that does not exist<br>
   * EXCPT_NE_COMM_LOSS - Raised when communications to managedElement is lost<br>
   * EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when maximum number of iterators that the EMS
   *  can support has been reached.
   * </dir>
   **/
   void getAllPTPs(
         in globaldefs::NamingAttributes_T managedElementName,
         in transmissionParameters::LayerRateList_T tpLayerRateList,
         in transmissionParameters::LayerRateList_T connectionLayerRateList,
         in unsigned long how_many,
         out terminationPoint::TerminationPointList_T tpList,
         out terminationPoint::TerminationPointIterator_I tpIt) 
         raises(globaldefs::ProcessingFailureException);

  /**
   * <p>This operation has exactly the same behaviour as 
   * <a href=_managedElementManager.ManagedElementMgr_I.html#managedElementManager::ManagedElementMgr_I::getAllPTPs>getAllPTPs</a>, but
   * instead of returning the entire object structures, this operation returns their names.</p>
   *
   * @parm globaldefs::NamingAttributes_T managedElementName: The name of the 
   * Managed Element.
   * @parm transmissionParameters::LayerRateList_T tpLayerRateList: List of PTP layer rates
   *  for which the PTPs are to be fetched. A PTP must contain at least one of the
   *  layer rates specified to be reported.  If the list is empty then PTPs of all rates
   *  are returned.
   * @parm transmissionParameters::LayerRateList_T connectionLayerRateList: List of connection 
   *  layer rates for which the PTPs are to be fetched. A PTP must support connections for at 
   *  least one of the
   *  layer rates specified to be reported.  If the list is empty then PTPs for all 
   *  connection rates are returned.
   * @parm in unsigned long how_many: Maximum number of PTPs to return in the first batch.
   * @parm globaldefs::NamingAttributesList_T nameList: First batch of PTPs.
   * @parm globaldefs::NamingAttributesIterator_I nameIt: Iterator to retrieve the remaining PTPs.
   * @raises globaldefs::ProcessingFailureException: 
   * As for <a href=_managedElementManager.ManagedElementMgr_I.html#managedElementManager::ManagedElementMgr_I::getAllPTPs>getAllPTPs</a>.
   **/
   void getAllPTPNames(
         in globaldefs::NamingAttributes_T managedElementName, 
         in transmissionParameters::LayerRateList_T tpLayerRateList,
         in transmissionParameters::LayerRateList_T connectionLayerRateList,
         in unsigned long how_many,
         out globaldefs::NamingAttributesList_T nameList,
         out globaldefs::NamingAttributesIterator_I nameIt)
         raises(globaldefs::ProcessingFailureException);


  /** 
   * <p>This service returns the termination point structure for the given TP name. 
   * The termination point structure contains transmission
   * parameters.  The transmission parameters returned will be the parameters
   * in place on the actual termination point on the NE.  If there are no
   * transmission parameters or the TP does not actually exist on the NE,
   * then transmissionParams will be empty. The field transmissionParams
   * will also be empty for "potential" ATM VP/VC CTPs.</p>
   * @parm globaldefs::NamingAttributes tpName: Name of the TP to retrieve.
   * @parm terminationPoint::TerminationPoint_T tp: The retrieved TP.
   * @raises globaldefs::ProcessingFailureException:<dir>
   * EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure<br>
   * EXCPT_INVALID_INPUT - Raised when tpName does not reference a termination point object<br>
   * EXCPT_ENTITY_NOT_FOUND - Raised when tpName references a TP object that does not exist<br>
   * EXCPT_NE_COMM_LOSS - Raised when communications to managedElement is lost<br>
   * </dir>
   **/
   void getTP(
         in globaldefs::NamingAttributes_T tpName,
         out terminationPoint::TerminationPoint_T tp) 
         raises (globaldefs::ProcessingFailureException);


  /** 
   * <p>This service returns the Managed Element for the given managed element name.</p>
   * @parm globaldefs::NamingAttributes managedElementName: Name of the ME to retrieve.
   * @parm managedElement::ManagedElement_T me: The retrieved ME.
   * @raises globaldefs::ProcessingFailureException:<dir>
   * EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure<br>
   * EXCPT_INVALID_INPUT - Raised when managedElementName does not reference a
   *  managed element object<br>
   * EXCPT_ENTITY_NOT_FOUND - Raised when managedElementName references an ME object
   *  that does not exist<br>
   * EXCPT_NE_COMM_LOSS - Raised when communications to the managed element is lost<br>
   * </dir>
   **/
   void getManagedElement(
         in globaldefs::NamingAttributes_T managedElementName,
         out managedElement::ManagedElement_T me) 
         raises (globaldefs::ProcessingFailureException);