multilayersubnetwork.idl

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

   * EXCPT_TIMESLOT_IN_USE - Raised if the SNC can not be activated because of timeslot conflicts
   *  with other SNCs<br>
   * EXCPT_UNABLE_TO_COMPLY - Raised if the SNC is in pending state and is in conflict
   *  with another active or partial SNC.  If the EMS can not distinguish the
   *  EXCPT_OBJECT_IN_USE and the EXCPT_TIMESLOT_IN_USE, it is allowed to throw
   *  EXCPT_UNABLE_TO_COMPLY<br>
   * EXCPT_NE_COMM_LOSS - Raised when communications to managedElement is lost and this
   *  prevents any change to the SNC<br>
   * </dir>
   **/
   void activateSNC(
         in    globaldefs::NamingAttributes_T               sncName,
         in    subnetworkConnection::GradesOfImpact_T       tolerableImpact,
         in    EMSFreedomLevel_T                            emsFreedomLevel,
         inout subnetworkConnection::TPDataList_T           tpsToModify,
         out   subnetworkConnection::SubnetworkConnection_T theSNC,
         out   string                                       errorReason)
     raises (globaldefs::ProcessingFailureException);


  /**
   * <p>This operation provides a way to create and activate a
   * subnetwork connection in one command.</p>
   *
   * <p>It conceptually behaves like a call to createSNC followed by a call to activateSNC.
   * Therefore, if the pending state is supported, it is possible for the SNC to be created
   * but activation to be rejected, and the resulting SNC will be in pending state.
   * If the pending state is not supported, then this is not possible and the SNC will not
   * be created if activation is rejected.
   * All success/failure conditions
   * that apply to the two base operations also apply to the combined
   * operation.  
   * If the SNC or any of its network resources have changed as a result of this operation,
   * then no exception can be
   * thrown so that theSNC can be passed back to the NMS.
   * Therefore, the exceptions that apply to activateSNC may not apply to the combined
   * operation: if the creation was successful but the activation is rejected (only possible
   * if the pending state is supported),
   * no exception shall be thrown and the resulting SNC shall be provided
   * in the out parameter theSNC.</p>
   *
   * <p>For more details on how this service affects the state of an SNC see
   * <a href=supportingDocumentation/modesOfOperation.html>SNC Management Modes of Operation</a>
   * and
   * <a href=supportingDocumentation/SNCStateDiagram.pdf>SNC state diagram</a>.</p>
   *
   * @parm SNCCreateData createData: structure describing the SNC to be created and activated.
   * @parm GradesOfImpact_T tolerableImpact: the maximum tolerable impact allowed.
   * @parm EMSFreedomLevel_T emsFreedomLevel: the maximum level of freedom allowed to the EMS
   * to perform the creation and activation.
   * @parm TPDataList_T tpsToModify: a list of TPs and parameters to apply, updated to 
   *  provide the resulting parameters.
   * @parm SubnetworkConnection theSNC: the resulting SNC.  
   *  It will have sncState and name set.  
   *  The EMS selects the SNC names
   *  so that they are not reused (within a reasonable time frame) for different SNCs.
   * @parm string errorReason: Specifies the creation and/or activation error(s) if any.
   * @raises globaldefs::ProcessingFailureException<dir>
   * EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure<br>
   * EXCPT_INVALID_INPUT - Raised when a field of createData is invalid<br>
   * EXCPT_OBJECT_IN_USE - Raised if the SNC can not be created and activated because of
   *  CC or CTP conflicts with other SNCs<br>
   * EXCPT_ENTITY_NOT_FOUND - Raised when fields of createData reference objects that
   *  do not exist<br>
   * EXCPT_TIMESLOT_IN_USE - Raised if the SNC can not be created and activated because of
   *  timeslot conflicts with other SNCs<br>
   * EXCPT_PROTECTION_EFFORT_NOT_MET - Raised if the NMS requests an SNC with a static
   *  protection level and protection effort that cannot be met by the EMS<br>
   * EXCPT_UNABLE_TO_COMPLY - Raised if the SNC is in conflict
   *  with another active or partial SNC and can not be created.
   *  If the EMS can not distinguish
   *  the EXCPT_OBJECT_IN_USE and the EXCPT_TIMESLOT_IN_USE, it is allowed to throw
   *  EXCPT_UNABLE_TO_COMPLY<br>
   * EXCPT_NE_COMM_LOSS - Raised when communications to managedElement is lost and this
   *  prevents creation of the SNC<br>
   * EXCPT_UNSUPPORTED_ROUTING_CONSTRAINTS - Raised if the EMS does not support the 
   *  routing constraints specified<br>
   * EXCPT_USERLABEL_IN_USE - Raised when the userLabel uniqueness constraint is not met<br>
   * </dir>
   **/
   void createAndActivateSNC(
         in    subnetworkConnection::SNCCreateData_T        createData,
         in    subnetworkConnection::GradesOfImpact_T       tolerableImpact,
         in    EMSFreedomLevel_T                            emsFreedomLevel,
         inout subnetworkConnection::TPDataList_T           tpsToModify,
         out   subnetworkConnection::SubnetworkConnection_T theSNC,
         out   string                                       errorReason)
     raises (globaldefs::ProcessingFailureException);


  /**
   * <p>Deactivating an SNC implies deletion in the ME of all 
   * the non-shared cross-connects that belong to this SNC. The ports are left 
   * in the same state
   * and are not put out of service.</p>
   *
   * <p>Failure - No exception thrown (except for cases described below).
   * If the SNC or any of its network resources have changed as a result of this operation,
   * then no exception can be
   * thrown so that theSNC can be passed back to the NMS.
   * The SNCState will be either SNCS_PARTIAL 
   * if the command partially completed or SNCS_ACTIVE if no cross-connects were 
   * deleted.  The errorReason will be detailed accordingly.</p>
   *
   * <p>Success - SNC is deactivated in the EMS and the SNCState is 
   * set to SNCS_PENDING in the out parameter theSNC. The parameter theSNC will contain the
   * attributes of the deactivated SNC. 
   * The errorReason parameter may be set to an empty string.</p>
   *
   * <p>For more details on how this service affects the state of an SNC see
   * <a href=supportingDocumentation/modesOfOperation.html>SNC Management Modes of Operation</a>
   * and
   * <a href=supportingDocumentation/SNCStateDiagram.pdf>SNC state diagram</a>.</p>
   *
   * <p>The EMS will apply the transmissionParams specified 
   * in the tpsToModify parameter (same behaviour as
   * <a href=_managedElementManager.ManagedElementMgr_I.html#managedElementManager::ManagedElementMgr_I::setTPData>setTPData</a>).
   * They may be applied before or after the creation of the CCs, as appropriate.
   * See <a href=supportingDocumentation/layeredParameters.html>transmissionParameters</a>.</p>
   * 
   * <p>If a given entry in the list of transmission parameters specified in
   * tpsToModify can not be successfully applied to the TP, for any reason, 
   * then the errorReason
   * field is appended with an appropriate reason text.
   * Applying transmission parameters is best-effort
   * and the resulting values of the transmission parameters
   * are provided in the updated tpsToModify parameter.</p>
   *
   * <p> Existing TP transmission parameters for which no changes
   * were requested in transmissionParams will be left unchanged. 
   * However, the alarm reporting on the CTPs and the containing TPs
   * may be turned off by the EMS
   * as part of this request, unless otherwise specified via the transmission parameter
   * "AlarmReporting".</p>
   * 
   * <p>An already deactivated SNC
   * can be deactivated again with success (the EMS is allowed to not send the
   * commands to the ME a second time however).
   * While in SNCS_PARTIAL state, it is possible to deactivate an 
   * SNC again, this 
   * corresponds to a retry.</p>
   *
   * <p>In case of a VP or VC SNC, this operation implies deletion in the ME of
   * all the non-shared VP or VC CTPs and VP or VC cross-connections involved in the SNC.
   * Note that in the case of a VC SNC deactivation, only the VC CTP and VC
   * cross-connections are normally deleted. VP CTPs must be explicitly
   * deleted using deactivateSNC on the VP SNC, except when emsFreedomLevel allows it. 
   * In that case, the VP CTP can be 
   * deleted along with the VC SNC if the VP CTP no longer contains any VC CTPs.</p>
   *
   * @parm NamingAttributes_T sncName: the name of the subnetwork connection to be deactivated.
   * @parm GradesOfImpact_T tolerableImpact: the maximum tolerable impact allowed.
   *  Indicates the amount of traffic disruption that the NMS user is willing
   *  to tolerate as a result of the deactivation request.
   * @parm EMSFreedomLevel_T emsFreedomLevel: the maximum level of freedom allowed to the EMS
   *  to perform the deactivation.
   * @parm TPDataList_T tpsToModify: a list of TPs and parameters to apply, updated to 
   *  provide the resulting parameters.
   * @parm SubnetworkConnection_T theSNC: the deactivated subnetwork connection.
   * @parm string errorReason: Specifies the deactivation error(s) if any.
   * @raises globaldefs::ProcessingFailureException<dir>
   * EXCPT_NOT_IMPLEMENTED - Raised if an EMS does not implement this service.<br>
   * EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure<br>
   * EXCPT_INVALID_INPUT - Raised when sncName does not refer to an SNC object, or any field
   *  in tpsToModify is invalid<br>
   * EXCPT_ENTITY_NOT_FOUND - Raised when sncName or tpsToModify reference an object that
   *  does not exist<br>
   * EXCPT_UNABLE_TO_COMPLY - Raised if the SNC is fixed and can not be deactivated.<br>
   * EXCPT_NE_COMM_LOSS - Raised when communications to managedElement is lost and this
   *  prevents the deactivation of the SNC<br>
   * </dir>
   **/
   void deactivateSNC(
         in    globaldefs::NamingAttributes_T               sncName,
         in    subnetworkConnection::GradesOfImpact_T       tolerableImpact,
         in    EMSFreedomLevel_T                            emsFreedomLevel,
         inout subnetworkConnection::TPDataList_T           tpsToModify,
         out   subnetworkConnection::SubnetworkConnection_T theSNC,
         out   string                                       errorReason)
        raises (globaldefs::ProcessingFailureException);

 
  /**
   *<p>This service allows an NMS to request the deletion of a 
   * SubnetworkConnection on a specified subnetwork.</p>
   *
   * <p>To delete a leg from a broadcast system, the subnetworkConnection 
   * that represents the leg is used as input to the deleteSNC operation.</p>
   *
   * <p>The SNC must not be in the active or partial state.</p>
   *
   * <p>Failure - An exception will be thrown if the operation fails.  The SNC object 
   * will not be deleted on the EMS.  The errorReason field of the exception
   * will contain the reason for the failure.</p>
   *
   * <p>Success - The SNC object is deleted on the EMS.</p>
   *
   * <p>For more details on how this service affects the state of an SNC see
   * <a href=supportingDocumentation/modesOfOperation.html>SNC Management Modes of Operation</a>
   * and
   * <a href=supportingDocumentation/SNCStateDiagram.pdf>SNC state diagram</a>.</p>
   *
   * @parm NamingAttributes_T sncName: the name of the subnetwork connection to be deleted.
   * @parm EMSFreedomLevel_T emsFreedomLevel: the maximum level of freedom allowed to the EMS
   *  to perform the deletion.
   * @raises globaldefs::ProcessingFailureException<dir>
   * EXCPT_NOT_IMPLEMENTED - Raised if an EMS does not implement this service<br>
   * EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure<br>
   * EXCPT_INVALID_INPUT - Raised when sncName does not refer to an SNC object<br>
   * EXCPT_ENTITY_NOT_FOUND - Raised when sncName references an object that does not exist<br>
   * EXCPT_NOT_IN_VALID_STATE - Raised if the SNC is in the partial or active state<br>
   * EXCPT_NE_COMM_LOSS - Raised when communications to managedElement is lost and this
   *  prevents the deletion of the SNC<br>
   * </dir>
   **/
   void deleteSNC(
         in  globaldefs::NamingAttributes_T sncName,
         in  EMSFreedomLevel_T emsFreedomLevel)
        raises (globaldefs::ProcessingFailureException);


  /**
   * <p>This operation provides a way to deactivate and then delete a 
   * subnetwork connection in one operation.</p>
   *
   * <p>It conceptually behaves like a call to deactivateSNC followed by a call to deleteSNC.
   * All success/failure conditions 
   * that apply to the two base operations also apply to the combined
   * operation.  
   * If the SNC or any of its network resources have changed as a result of this operation,
   * then no exception can be
   * thrown so that theSNC can be passed back to the NMS.
   * Therefore, the exceptions that apply to deleteSNC may not apply to the combined
   * operation: if the deactivation changed the SNC but the deletion is rejected,
   * no exception should be thrown and the resulting SNC should be provided
   * in the out parameter theSNC.</p>
   *
   * <p>The parameter theSNC
   * will identify the SNC after the combined operation.
   * If the operation is entirely successful,
   * sncState will be SNCS_NONEXISTENT.
   * In that case, this object does not exist on the EMS and the NMS should only look at 
   * sncState.  This work around is so that the NMS can have a 
   * combined operation. </p>
   *
   * <p>For more details on how this service affects the state of an SNC see
   * <a h