equipment.idl

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

   };


  /**
   * <p>The EquipmentInventoryMgr_I is used to gain access to operations
   * which deal with equipment</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 EquipmentInventoryMgr_I: common::Common_I
   {

   /**
   * <p> This operation allows the NMS to permanently provision an equipment in
   * an equipment holder in a Managed Element. 
   * The successful result of this operation is the creation or update of the equipment object 
   * and the creation of all its related objects such as Termination Points. 
   * The resulting object will be returned. </p>
   *
   * <p>The equipment holder that will contain the equipment must exist.
   * The equipment object may already exist, but the equipment holder must not have
   * an expected equipment already provisioned.
   * See <a href=supportingDocumentation/equipmentStates.pdf>Equipment Holder States</a>.</p>
   *
   * @parm EQTCreateData_T equipmentCreateData: data that describes the equipment to create.
   * @parm Equipment_T createEquipment: the resulting created equipment.
   * @raises globaldefs::ProcessingFailureException<dir>
   * EXCPT_NOT_IMPLEMENTED - Raised if EMS can not support this service<br>
   * EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure<br>
   * EXCPT_OBJECT_IN_USE - Raised when the equipment holder already has an expected equipment<br>
   * EXCPT_INVALID_INPUT - Raised when equipmentHolder does not reference an equipmentHolder
   *  object<br>
   * EXCPT_ENTITY_NOT_FOUND - Raised when equipmentHolder references object that does not exist<br>
   * EXCPT_UNABLE_TO_COMPLY - Raised when the equipment can not be created at the NE<br>
   * EXCPT_NE_COMM_LOSS - Raised when communications to managedElement is lost<br>
   * </dir>
   **/
   void provisionEquipment(
      in  EQTCreateData_T equipmentCreateData,
      out Equipment_T     createdEquipment)
        raises(globaldefs::ProcessingFailureException);

   /**
   * <p> This operation allows the NMS to permanently unprovision an equipment
   * from the Managed Element.
   * The successful result of this operation is the potential deletion of the equipment object 
   * and the deletion of all its related objects such as Termination Points.</p>
   *
   * <p>The EMS should attempt to set the equipment to OUT_OF_SERVICE_BY_MAINTENANCE
   * before it unprovisions it.</p>
   *
   * @parm globaldefs::NamingAttributes_T equipmentName:
   *       the name of equipment to be unprovisioned.
   * @raises globaldefs::ProcessingFailureException<dir>
   * EXCPT_NOT_IMPLEMENTED - Raised if EMS does not support this service<br>
   * EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure<br>
   * EXCPT_INVALID_INPUT - Raised when equipmentName does not reference an equipment object<br>
   * EXCPT_OBJECT_IN_USE - Deletion is rejected because equipment resources are in use<br>
   * EXCPT_ENTITY_NOT_FOUND - Raised when equipmentName references object which does not exist<br>
   * EXCPT_UNABLE_TO_COMPLY -  Raised when the equipment can not be unprovisioned at the NE.<br>
   * EXCPT_NE_COMM_LOSS - Raised when communications to managedElement is lost<br>
   * </dir>
   **/
   void unprovisionEquipment(
      in  globaldefs::NamingAttributes_T equipmentName)
        raises(globaldefs::ProcessingFailureException);

   /**
   * <p>This operation enables (activates, or turns on) alarm reporting 
   * on an equipment or equipment holder.  
   * Only alarms from the equipment or equipment holder (not TP alarms)
   * are turned on.</p>
   *
   * <p>The EMS sends an attribute value change notification in case of success.</p>
   *
   * @parm globaldefs::NamingAttributes_T equipmentOrHolderName: the equipment or holder on which
   *  to activate alarm reporting.
   * @raises globaldefs::ProcessingFailureException<dir>
   * EXCPT_NOT_IMPLEMENTED - Raised if EMS does not support this service<br>
   * EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure<br>
   * EXCPT_INVALID_INPUT - Raised when equipmentOrHolderName does not reference an equipment
   *  or holder<br>
   * EXCPT_ENTITY_NOT_FOUND - Raised when equipmentOrHolderName references an object
   *  that does not exist<br>
   * EXCPT_UNABLE_TO_COMPLY -  Raised when alarm reporting can not be enabled for the equipment
   * or holder<br>
   * EXCPT_NE_COMM_LOSS - Raised when communications to managedElement is lost<br>
   * </dir>
   **/
   void setAlarmReportingOn(
      in globaldefs::NamingAttributes_T equipmentOrHolderName)
      raises(globaldefs::ProcessingFailureException);


   /**
   * <p> This operation disables (deactivates, or turns off) alarm reporting on an
   * equipment or equipment holder.  Only alarms from the equipment or holder (not TP alarms)
   * are turned off.</p>
   *
   * <p>The EMS sends an attribute value change notification in case of success.</p>
   *
   * @parm globaldefs::NamingAttributes_T equipmentOrHolderName: name of the equipment or holder
   * on which to deactivate alarm reporting.
   * @raises globaldefs::ProcessingFailureException<dir>
   * EXCPT_NOT_IMPLEMENTED - Raised if EMS does not support this service<br>
   * EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure<br>
   * EXCPT_INVALID_INPUT - Raised when equipmentOrHolderName does not reference an equipment
   *  or holder<br>
   * EXCPT_ENTITY_NOT_FOUND - Raised when equipmentOrHolderName references an object
   *  that does not exist<br>
   * EXCPT_UNABLE_TO_COMPLY -  Raised when alarm reporting can not be disabled for the equipment
   *  or holder<br>
   * EXCPT_NE_COMM_LOSS - Raised when communications to managedElement is lost<br>
   * </dir>
   **/
   void setAlarmReportingOff(
      in globaldefs::NamingAttributes_T equipmentOrHolderName)
      raises(globaldefs::ProcessingFailureException);


   /**
   * <p> This service returns the equipments and equipment holders directly contained by a
   * specific equipment holder.  This method differs from getAllEquipment in that it only
   * looks at the next level of the containment hierachy.
   * </p>
   *
   * @parm globaldefs::NamingAttributes_T equipmentHolderName: name of the equipment holder
   * for which to retrieve the directly contained equipment and equipment holders.
   * @parm EquipmentOrHolderList_T equipmentOrHolderList: the directly contained equipments
   *  and equipment holders.
   * @raises globaldefs::ProcessingFailureException<dir>
   * EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure<br>
   * EXCPT_INVALID_INPUT - Raised when equipmentHolderName does not reference an equipment
   *  holder object<br>
   * EXCPT_ENTITY_NOT_FOUND - Raised when equipmentHolderName references an equipment holder
   *  that does not exist<br>
   * EXCPT_NE_COMM_LOSS - Raised when communications to managedElement is lost<br>
   * </dir>
   **/
   void getContainedEquipment (
      in globaldefs::NamingAttributes_T equipmentHolderName,
      out EquipmentOrHolderList_T       equipmentOrHolderList)
      raises(globaldefs::ProcessingFailureException);


   /**
   * <p> This service returns the equipment or equipment holder for the given equipment 
   * or equipment holder name.</p>
   *
   * @parm globaldefs::NamingAttributes_T equipmentOrHolderName: name of the equipment or
   * equipment holder to retrieve.
   * @parm EquipmentOrHolder_T equip: the returned equipment or equipment holder.
   * @raises globaldefs::ProcessingFailureException<dir>
   * EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure<br>
   * EXCPT_INVALID_INPUT - Raised when equipmentOrHolderName does not reference an equipment
   *  nor an equipment holder<br>
   * EXCPT_ENTITY_NOT_FOUND - Raised when equipmentOrHolderName references an equipment or 
   *  equipment holder that does not exist<br>
   * EXCPT_NE_COMM_LOSS - Raised when communications to managedElement is lost<br>
   * </dir>
   **/
   void getEquipment(
      in globaldefs::NamingAttributes_T equipmentOrHolderName,
      out EquipmentOrHolder_T           equip)
      raises(globaldefs::ProcessingFailureException);


  /** <p> This allows an NMS to request all of the equipments and equipment holders that are
   * contained in a managed element or equipment holder.</p>
   *
   * @parm globaldefs::NamingAttributes_T meOrHolderName:
   *       the name of the ME or equipment holder for which to retrieve contained equipments
   *       and equipment holders.
   * @parm unsigned long how_many: maximum number of EquipmentOrHolder_Ts to return 
   *       in the first batch.
   * @parm EquipmentOrHolderList_T eqList: the first batch of EquipmentOrHolder_Ts.
   * @parm EquipmentOrHolderIterator_I eqIt: the iterator used to retrieve the remaining
   * EquipmentOrHolder_Ts.
   * @raises globaldefs::ProcessingFailureException<dir>
   * EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure<br>
   * EXCPT_INVALID_INPUT - Raised when managedElementOrEquipmentName does not reference a
   * managed element or an equipment holder<br>
   * EXCPT_ENTITY_NOT_FOUND - Raised when managedElementOrEquipmentName references object
   * which 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.<br>
   * </dir>
   **/
   void getAllEquipment(
      in  globaldefs::NamingAttributes_T     meOrHolderName,
      in  unsigned long                      how_many,
      out EquipmentOrHolderList_T            eqList,
      out EquipmentOrHolderIterator_I        eqIt)
      raises(globaldefs::ProcessingFailureException);


   /**
   * <p>This operation has exactly the same behaviour as 
   * <a href=_equipmentInventory.EquipmentInventoryMgr_I.html#equipmentInventory::EquipmentInventoryMgr_I::getAllEquipment>getAllEquipment</a>, but 
   * returns the object names instead of returning the 
   * entire objects.</p> 
   * 
   * @parm globaldefs::NamingAttributes_T meOrHolderName:
   *       the name of the ME or equipment holder for which to retrieve contained equipment
   *       and equipment holder names.
   * @parm  unsigned long how_many: maximum number of names to return 
   *       in the first batch.
   * @parm  globaldefs::NamingAttributesList_T nameList: the first batch of names.
   * @parm  globaldefs::NamingAttributesListIterator_I nameIt: the iterator to retrieve the 
   *  remaining names.
   * @raises As for <a href=_equipmentInventory.EquipmentInventoryMgr_I.html#equipmentInventory::EquipmentInventoryMgr_I::getAllEquipment>getAllEquipment</a>.
   * </dir>
   **/
   void getAllEquipmentNames(
      in globaldefs::NamingAttributes_T           meOrHolderName,
      in unsigned long                            how_many,
      out globaldefs::NamingAttributesList_T      nameList,
      out globaldefs::NamingAttributesIterator_I  nameIt)
      raises(globaldefs::ProcessingFailureException);


  /**
   * <p> This service allows an NMS to request the PTPs that are
   * directly supported by a given equipment. The PTPs that are returned
   * are those that share their physical layer with the primary equipment (i.e. that
   * represent a port on the equipment or are connected by a fibre, wire, etc.).</p>
   *
   * <p>When there is equipment protection, this operation reports PTPs for the primary
   * equipment only.  That is, when called on a protecting equipment (as opposed to
   * the primary equipment), this operation returns an empty list, irrespective of the 
   * current switch status.</p>
   *
   * @parm globaldefs::NamingAttributes_T equipmentName: the name of the equipment for which
   * to retrieve supported PTPs.
   * @parm  unsigned long how_many: the maximum number of PTPs to be reported in the first batch.
   * @parm  TerminationPointList_T tpList: the first batch of PTPs.
   * @parm  TerminationPointIterator_I tpIt: the iterator to retrieve the remaining PTPs.
   * @raises globaldefs::ProcessingFailureException<dir>
   * EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure<br>
   * EXCPT_INVALID_INPUT - Raised when equipmentName does not reference an equipment object<br>
   * EXCPT_ENTITY_NOT_FOUND - Raised when equipmentName references 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.<br>
   * </dir>
   **/
   void getAllSupportedPTPs(
      in  globaldefs::NamingAttributes_T               equipmentName,
      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 
   * getAllSupportedPTPs, but 
   * returns the object names instead of returning the 
   * entire objects.</p> 
   * 
   * @parm  globaldefs::NamingAttributes_T equipmentName: the name of the equipment for which
   * to retrieve supported PTPs.
   * @parm  unsigned long how_many: the maximum number of PTP names to be reported
   * in the first batch.
   * @parm  globaldefs::NamingAttributesList_T nameList: the first batch of PTP names.
   * @parm  globaldefs::NamingAttributesListIterator_I nameIt: the iterator to retrieve the
   * remaining PTP names.
   * @raises As for <a href=_equipmentInventory.EquipmentInventoryMgr_I.html#equipmentInventory::EquipmentInventoryMgr_I::getAllSupportedPTPs>getAllSupportedPTPs</a>.
   * </dir>
   **/
   void getAllSupportedPTPNames(
      in globaldefs::NamingAttributes_T equipmentName,
      in  unsigned long how_many,
      out globaldefs::NamingAttributesList_T   nameList,
      out globaldefs::NamingAttributesIterator_I  nameIt)
      raises(globaldefs::ProcessingFailureException);


   /** 
   * <p> This service allows an NMS to request all of the equipment 
   * which implement a PTP.  The equipments that are returned
   * are those which support the physical layer of the PTP (i.e. have the
   * port on them or are connected by a fibre, wire, etc.). For a particular PTP
   * the Tx port and Rx port may be on different cards and in this case
   * both should be returned.
   * Equipment that are used by the PTPs, but that do not support them directly (such as
   * a shared DEMUX card) are not reported.</p>
   *
   * @parm globaldefs::NamingAttributes_T ptpName: the name of the PTP for which to retrieve
   * the supporting equipments.
   * @parm  EquipmentOrHolderList_T eqList: the list of equipments (not 
   *  equipment holders) directly implementing the PTP.
   * @raises globaldefs::ProcessingFailureException<dir>
   * EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure<br>
   * EXCPT_INVALID_INPUT - Raised when ptpName does not reference a PTP object<br>
   * EXCPT_ENTITY_NOT_FOUND - Raised when ptpName references a PTP object that does not exist<br>
   * EXCPT_NE_COMM_LOSS - Raised when communications to managedElement is lost
   * </dir>
   **/
   void getAllSupportingEquipment(
      in globaldefs::NamingAttributes_T ptpName,
      out EquipmentOrHolderList_T       eqList)
      raises(globaldefs::ProcessingFailureException);


   /**
   * <p>This operation has exactly the same behaviour as 
   * <a href=_equipmentInventory.EquipmentInventoryMgr_I.html#equipmentInventory::EquipmentInventoryMgr_I::getAllSupportingEquipment>getAllSupportingEquipment</a>,
   * but returns the object names instead of returning the 
   * entire objects.</p> 
   * 
   * @parm globaldefs::NamingAttributes_T ptpName: the name of the PTP for which to retrieve
   * the supporting equipments.
   * @parm  globaldefs::NamingAttributesList_T nameList: the list of equipment names (not 
   *  equipment holder names) directly implementing the PTP.
   * @raises As for <a href=_equipmentInventory.EquipmentInventoryMgr_I.html#equipmentInventory::EquipmentInventoryMgr_I::getAllSupportingEquipment>getAllSupportingEquipment</a>.
   * </dir>
   **/
   void getAllSupportingEquipmentNames(
      in globaldefs::NamingAttributes_T         ptpName,
      out globaldefs::NamingAttributesList_T    nameList)
      raises(globaldefs::ProcessingFailureException);


   };      // END EquipmentMgr_I

};       // end of module

#endif