transmissiondescriptor.idl

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

   typedef sequence<TransmissionDescriptor_T> TransmissionDescriptorList_T;


  /**
   * <p>In order to allow the NMS to deal with a large number of objects,
   * iterators are used.</p>
   * <p>See <a href=supportingDocumentation/iterators.pdf>iterator overview</a>
   * for information on how iterators are used in this interface.</p>
   **/

  interface TransmissionDescriptorIterator_I 
    {
        boolean next_n(
               in unsigned long how_many,
               out TransmissionDescriptorList_T transmissionDescList)
              raises (globaldefs::ProcessingFailureException);

        unsigned long getLength() 
              raises (globaldefs::ProcessingFailureException);

        void destroy() 
              raises (globaldefs::ProcessingFailureException);
    };



  /**
   * <p>The transmissionDescriptorManager is used to gain access to operations
   * that deal with Transmission Descriptor.</p>
   *
   * <p>A handle to an instance of this interface is gained via the
   * emsSession::EmsSession_I::getManager()  operation in Manager.</p>
   **/

  interface TransmissionDescriptorMgr_I : common::Common_I
    {

  /**
   * <p>This allows an NMS to request all of the transmissionDescriptors that
   * are under the control of the transmissionDescriptorMgr_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.pdf>iterator overview</a>
   * for information on how iterators are used in this interface.</p>
   * 
   * <br>unsigned long how_many: number of iterators to return in 
   * transmissionDescList.
   * <br>transmissionDescriptor::TransmissionDescriptorList 
   * transmissionDescList: the first batch of iterators.
   * <br>transmissionDescriptor::TransmissionDescriptorIterator_I 
   * transmissionDescIt: the iterator used to access the remaining Transmission 
   * Descriptors.
   * <br><b>Raises</b> globaldefs::ProcessingFailureException <br>
   * EXCPT_NOT_IMPLEMENTED - Raised if the EMS does not support this service<br>
   * 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<br>
   * <br>
   **/
   void getAllTransmissionDescriptors(
         in unsigned long how_many,
         out TransmissionDescriptorList_T transmissionDescList,
         out TransmissionDescriptorIterator_I transmissionDescIt)
        raises (globaldefs::ProcessingFailureException);

  /**
   * <p>This operation has exactly the same behaviour as 
   * getAllTransmissionDescriptors, 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.pdf>iterator overview</a>
   * for information on how iterators are used in this interface.</p>
   *
   * <br>unsigned long how_many: the number of iterators to return in 
   * nameList.
   * <br>globaldefs::NamingAttributesList_T nameList: the first batch of 
   * iterator names.
   * <br>globaldefs::NamingAttributesIterator_I nameIt: the iterator used to 
   * retrieve the remaining iterator names.
   * <br><b>Raises</b> globaldefs::ProcessingFailureException <br>
   *  As for getAllTransmissionDescriptors.
   **/
   void getAllTransmissionDescriptorNames(
         in unsigned long how_many,
         out globaldefs::NamingAttributesList_T nameList,
         out globaldefs::NamingAttributesIterator_I nameIt)
        raises(globaldefs::ProcessingFailureException);

  /** 
   * <p>This service returns the Transmission Descriptor struct for the given 
   * tmdName. The Transmission Descriptor structure contains an NVSList of 
   * traffic parameters.  The traffic parameters returned will be the parameters
   * in place on the actual Transmission Descriptor.  If there are no
   * traffic parameters, then the NVSList will be empty.</p>
   * <br>globaldefs::NamingAttributes_T tmdName: name of the Transmission 
   * Descriptor.
   * <br>TransmissionDescriptor_T tmd : the returned Transmission Descriptor.
   * <br><b>Raises</b> globaldefs::ProcessingFailureException <br>
   * EXCPT_NOT_IMPLEMENTED - Raised if the 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 tmdName does not reference 
   *  trasmissionDescriptor object<br>
   * EXCPT_ENTITY_NOT_FOUND - Raised when tmdName references object which does 
   *  not exist<br>
   * <br>
   **/
   void getTransmissionDescriptor(
         in globaldefs::NamingAttributes_T tmdName,
         out TransmissionDescriptor_T tmd) 
        raises (globaldefs::ProcessingFailureException);

  /**
   * <p>This allows an NMS to request all of the TPs associated with the  
   * specified Transmission Descriptor. If there are no TPs which are 
   * associated with the specified Transmission Descriptor, then an empty list 
   * is returned. </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.pdf>iterator overview</a>
   * for information on how iterators are used in this interface.</p>
   * 
   * <br>globaldefs::NamingAttributes_T transmissionDescriptorName: the name of 
   * the Transmission Descriptor.
   * <br>unsigned long how_many: maximum number of TPs to return in the 
   * first batch.
   * <br>terminationPoint::TerminationPointList tpList: first batch of 
   * TPs.
   * <br>terminationPoint::TerminationPointIterator_I tpIt: iterator to 
   * access the remaining TPs.
   * <br><b>Raises</b> globaldefs::ProcessingFailureException <br>
   * EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal 
   *  failure<br>
   * EXCPT_INVALID_INPUT - Raised when transmissionDescriptrName does not 
   *  reference a Transmission Descriptor object<br>
   * EXCPT_ENTITY_NOT_FOUND - Raised when transmissionDescriptorName 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<br>
   * <br>
   **/
   void getAssociatedTPs(
         in globaldefs::NamingAttributes_T transmissionDescriptorName,
         in unsigned long how_many,
         out terminationPoint::TerminationPointList_T tpList,
         out terminationPoint::TerminationPointIterator_I tpIt) 
        raises(globaldefs::ProcessingFailureException);

  /**
   * <p>The createTransmissionDescriptor operation is used to create
   * a new Transmission Descriptor on the server. A Transmission Descriptor 
   * create data representing the new Transmission Descriptor is 
   * passed as input. The resulting Transmission Descriptor is 
   * returned as a result.</p>
   *
   * <br>TMDCreateData_T newTMDCreateData: information about the Transmission 
   * Descriptor to be created.
   * <br>TransmissionDescriptor_T newTransmissionDescriptor: result of the 
   * creation.
   * <br><b>Raises</b> globaldefs::ProcessingFailureException <br>
   * EXCPT_NOT_IMPLEMENTED - Raised if EMS does not support creation of TMDs via 
   *  this interface<br>
   * EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal 
   *  failure<br>
   * EXCPT_INVALID_INPUT - Raised if newTMDCreateData contains invalid data<br>
   * EXCPT_USERLABEL_IN_USE - Raised when the userLabel uniqueness constraint is 
   *  not met<br>
   * EXCPT_CAPACITY_EXCEEDED - Raised when maximum number of Transmission 
   *  Descriptors has been reached<br>
   * <br>
   **/
   void createTransmissionDescriptor(
         in  TMDCreateData_T      newTMDCreateData,
         out TransmissionDescriptor_T newTransmissionDescriptor)
        raises (globaldefs::ProcessingFailureException);


  /**
   * <p>The delete Transmission Descriptor operation is used to 
   * delete a Transmission Descriptor on the server. This operation is
   * idempotent. If the service is called with the
   * name of a non-existent Transmission Descriptor, it will succeed.</p>
   *
   * <br>globaldefs::NamingAttributes_T transmissionDescriptorName
   * <br><b>Raises</b> globaldefs::ProcessingFailureException <br>
   * EXCPT_NOT_IMPLEMENTED - Raised if EMS does not support deletion of TMDs via 
   *  this interface<br>
   * EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal 
   *  failure<br>
   * EXCPT_OBJECT_IN_USE - Raised if there are TPs that are using
   *  the Transmission Descriptor<br>
   * EXCPT_INVALID_INPUT - Raised when input parameter is syntactical incorrect.
   * EXCPT_ENTITY_NOT_FOUND - Raised when the Transmission Descriptor to be 
   *  deleted does not exist.
   * <br>
  **/
   void deleteTransmissionDescriptor(
         in globaldefs::NamingAttributes_T transmissionDescriptorName)
         raises (globaldefs::ProcessingFailureException);
};

}; // END OF MODULE

#endif