multilayersubnetwork.idl

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

         out managedElement::ManagedElementList_T meList,
         out managedElement::ManagedElementIterator_I meIt) 
	     raises(globaldefs::ProcessingFailureException);


  /**
   * <p>This operation has exactly the same behaviour as 
   * <a href=_multiLayerSubnetwork.MultiLayerSubnetworkMgr_I.html#multiLayerSubnetwork::MultiLayerSubnetworkMgr_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 globaldefs::NamingAttributes subnetName: Name of the subnetwork.
   * @parm unsigned long how_many: Maximum number of managed element names to return
   * in the first batch.
   * @parm globaldefs::NamingAttributesList_T nameList: First batch of managed element names.
   * @parm globaldefs::NamingAttributesIterator_I nameIt: Iterator to retrieve the remaining
   * managed element names.
   * @raises globaldefs::ProcessingFailureException
   * As for <a href=_multiLayerSubnetwork.MultiLayerSubnetworkMgr_I.html#multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::getAllManagedElements>getAllManagedElements</a>.
   **/
   void getAllManagedElementNames(
         in globaldefs::NamingAttributes_T subnetName,
         in unsigned long how_many,
         out globaldefs::NamingAttributesList_T nameList,
         out globaldefs::NamingAttributesIterator_I nameIt)
        raises(globaldefs::ProcessingFailureException);


  /**
   * <p>This service returns a Subnetwork given a subnetwork name.</p>
   * 
   * @parm globaldefs::NamingAttributes subnetName: Name of the subnetwork to retrieve.
   * @parm MultiLayerSubnetwork_T subnetwork: Subnetwork structure returned.
   * @raises globaldefs::ProcessingFailureException<dir>
   * EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure<br>
   * EXCPT_INVALID_INPUT - Raised when subnetName does not reference a multiLayerSubnetwork
   *  object<br>
   * EXCPT_ENTITY_NOT_FOUND - Raised when subnetName references a multiLayerSubnetwork object
   *  that does not exist<br>
   * </dir>
   **/
   void getMultiLayerSubnetwork(
         in globaldefs::NamingAttributes_T subnetName,
         out MultiLayerSubnetwork_T subnetwork)
        raises(globaldefs::ProcessingFailureException);


  /**
   * <p>This service returns a list of TopologicalLinks which exist inside the
   * Subnetwork whose name is passed as a parameter.  For singletons, no
   * topologicalLinks will be returned.  The EMS should report topological links
   * at the "lowest" layer (i.e. closest to physical) about which it has accurate
   * knowledge.</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>
   * 
   * <p>For details on how topologicalLinks should be modelled see
   * <a href=supportingDocumentation/layers.pdf>layering</a>.</p>
   * 
   * @parm  globaldefs::NamingAttributes_T subnetName: The name of the Subnetwork.
   * @parm  unsigned long how_many: Maximum number of topological links to return in 
   * the first batch.
   * @parm  topologicalLink::TopologicalLinkList_T topoList: First batch of topological links.
   * @parm  topologicalLink::TopologicalLinkIterator_I topoIt: Iterator to retrieve the remaining
   * topological links.
   * @raises globaldefs::ProcessingFailureException<dir>
   * EXCPT_NOT_IMPLEMENTED - Raised if EMS cannot support this service<br>
   * EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure<br>
   * EXCPT_INVALID_INPUT - Raised when subnetName does not reference a multiLayerSubnetwork
   *  object<br>
   * EXCPT_ENTITY_NOT_FOUND - Raised when subnetName references an 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 getAllTopologicalLinks(
         in globaldefs::NamingAttributes_T subnetName,
         in unsigned long how_many,
         out topologicalLink::TopologicalLinkList_T topoList,
         out topologicalLink::TopologicalLinkIterator_I topoIt) 
         raises(globaldefs::ProcessingFailureException);


  /**
   * <p>This operation has exactly the same behaviour as 
   * getAllTopologicalLinks, 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  globaldefs::NamingAttributes_T subnetName: The name of the Subnetwork.
   * @parm unsigned long how_many: Maximum number of topological link names
   *  to return in the first batch.
   * @parm globaldefs::NamingAttributesList_T nameList: First batch of topological link names.
   * @parm globaldefs::NamingAttributesListIterator_I nameIt: Iterator to retrieve the remaining
   *  topological link names.
   * @raises globaldefs::ProcessingFailureException:
   *  As for getAllTopologicalLinks.
   **/
   void getAllTopologicalLinkNames(
         in globaldefs::NamingAttributes_T subnetName,
         in  unsigned long how_many,
         out globaldefs::NamingAttributesList_T nameList,
         out globaldefs::NamingAttributesIterator_I nameIt)
         raises(globaldefs::ProcessingFailureException);


  /**
   * <p>This service returns a subnetwork topological link given its name.</p>
   * 
   * @parm globaldefs::NamingAttributes topoLinkName: Name of the subnetwork 
   *  topological link to retrieve.
   * @parm TopologicalLink_T topoLink: Subnetwork topological link returned.
   * @raises globaldefs::ProcessingFailureException<dir>
   * EXCPT_NOT_IMPLEMENTED - Raised if EMS cannot support this service<br>
   * EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure<br>
   * EXCPT_INVALID_INPUT - Raised when topoLinkName does not reference a subnetwork topological
   *  link object<br>
   * EXCPT_ENTITY_NOT_FOUND - Raised when topoLinkName references a subnetwork topological link
   *  object that does not exist<br>
   * </dir>
   **/
   void getTopologicalLink(
         in globaldefs::NamingAttributes_T topoLinkName,
         out topologicalLink::TopologicalLink_T topoLink)
        raises(globaldefs::ProcessingFailureException);


  /**
   * <p>This allows an NMS to request a list of the edge termination points for the
   * specified subnetwork, at one or more of the NMS-specified layers, and
   * that are capable of containing CTPs that can be connected
   * at one or more of the NMS-specified
   * connection layer rates.  This operation considers the capability/flexibility of the TPs,
   * not their current states.</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 subnetName: Name of the subnetwork.
   * @parm transmissionParameters::LayerRateList_T tpLayerRateList: List of TP layer rates
   *  for which the edge points are to be fetched. An edge point must contain at least one of the
   *  layer rates specified to be reported.  If the list is empty then edge points
   *  of all rates are returned.
   * @parm transmissionParameters::LayerRateList_T connectionLayerRateList: List of connection 
   *  layer rates for which the edge points are to be fetched. An edge point must support 
   *  connections for at least one of the
   *  layer rates specified to be reported.  If the list is empty then edge points for all 
   *  connection rates are returned.
   * @parm unsigned long how_many: Maximum number of edge points to return in the first batch.
   * @parm terminationPoint::TerminationPointList tpList: First batch of edge points.
   * @parm terminationPoint::TerminationPointIterator_I tpIt: Iterator to retrieve the remaining
   *  edge points.
   * @raises globaldefs::ProcessingFailureException<dir>
   * EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure<br>
   * EXCPT_INVALID_INPUT - Raised when subnetName does not reference a multiLayerSubnetwork object,
   *  or tpLayerRateList or connectionLayerRateList contain undefined values<br>
   * EXCPT_ENTITY_NOT_FOUND - Raised when subnetName references an 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 getAllEdgePoints(
         in globaldefs::NamingAttributes_T subnetName,
         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=_multiLayerSubnetwork.MultiLayerSubnetworkMgr_I.html#multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::getAllEdgePoints>getAllEdgePoints</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 globaldefs::NamingAttributes subnetName: Name of the subnetwork.
   * @parm transmissionParameters::LayerRateList_T tpLayerRateList: List of TP layer rates
   *  for which the edge points are to be fetched. An edge point must contain at least one of the
   *  layer rates specified to be reported.  If the list is empty then edge points
   *  of all rates are returned.
   * @parm transmissionParameters::LayerRateList_T connectionLayerRateList: List of connection 
   *  layer rates for which the edge points are to be fetched. An edge point must support 
   *  connections for at least one of the
   *  layer rates specified to be reported.  If the list is empty then edge points for all 
   *  connection rates are returned.
   * @parm unsigned long how_many: Maximum number of edge points to return in the first batch.
   * @parm globaldefs::NamingAttributesList_T nameList: First batch of edge point names.
   * @parm globaldefs::NamingAttributesIterator_I tpIt: Iterator to retrieve the remaining
   * edge point names.
   * @raises globaldefs::ProcessingFailureException
   * As for <a href=_multiLayerSubnetwork.MultiLayerSubnetworkMgr_I.html#multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::getAllEdgePoints>getAllEdgePoints</a>.
   * </dir>
   **/
   void getAllEdgePointNames(
         in globaldefs::NamingAttributes_T subnetName,
         in transmissionParameters::LayerRateList_T layerRateList,
         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 a list of PSR (UPSR or SNCP) associated termination points 
   * for the TP whose name is passed as a parameter.</p> 
   *
   * <p>To create an SNC in a TOPO_OPEN_PSR for instance, the NMS needs to have two zEnd
   * CTPs which are in the same SONET or SDH timeslot. The service allows the NMS 
   * to query the associated CTP of a given CTP or associated PTP given a PTP.
   * The timeslot of the TPs will be the same in the
   * case of a TOPO_OPEN_PSR subnetwork, but the names of the
   * two TPs will be different.
   * This operation is symmetric on the associated TPs.
   * Given a working TP, the associated TP will be the protecting TP.</p>
   *
   * <p>When this service is invoked with a TP that is not an edge point, the returned
   * TPs will be on the same Managed Element.</p>
   *    
   * <p>See <a href=_terminationPoint.html#terminationPoint::TPProtectionAssociation_T>
   * TPProtectionAssociation_T</a> for more information.</p>
   *
   * @parm globaldefs::NamingAttributes tpName: The name of the TP for which to retrieve
   * associated TPs.
   * @parm terminationPoint::TerminationPointList_T tpList: The PSR associated TPs.  If there 
   * are no PSR associated TPs, then an empty list is returned.  
   * @raises globaldefs::ProcessingFailureException<dir>