trafficdescriptor.idl

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

   * <p>A list of Traffic Descriptors.</p>
   **/
   typedef sequence<TrafficDescriptor_T> TrafficDescriptorList_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.html>iterator overview</a>
   * for information on how iterators are used in this interface.</p>
   **/

  interface TrafficDescriptorIterator_I 
    {
        boolean  next_n(in unsigned long                how_many,
                        out TrafficDescriptorList_T         trafficDescList)
                 raises (globaldefs::ProcessingFailureException);

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

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



  /**
   * <p>The trafficDescriptorManager is used to gain access to operations
   * that deal with traffic descriptors </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 TrafficDescriptorMgr_I : common::Common_I
    {

  /**
   * <p>This allows an NMS to request all of the trafficDescriptors that
   * are under the control of the trafficDescriptorMgr_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: number of iterators to return in trafficDescList.
   * @parm  trafficDescriptor::TrafficDescriptorList trafficDescList: the first
   * batch of iterators.
   * @parm  trafficDescriptor::TrafficDescriptorIterator_I trafficDescIt: the iterator
   * used to access the remaining traffic descriptors.
   * @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<br>
   * </dir>
   **/
   void getAllTrafficDescriptors(
           in unsigned long how_many,
           out TrafficDescriptorList_T trafficDescList,
           out TrafficDescriptorIterator_I trafficDescIt)
        raises (globaldefs::ProcessingFailureException);

  /**
   * <p>This operation has exactly the same behaviour as getAllTrafficDescriptors, 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: the number of iterators to return in nameList.
   * @parm globaldefs::NamingAttributesList_T nameList: the first batch of iterator names.
   * @parm globaldefs::NamingAttributesIterator_I nameIt: the iterator used to retrieve
   * the remaining iterator names.
   * @raises globaldefs::ProcessingFailureException:
   * As for getAllTrafficDescriptors.
   **/
   void getAllTrafficDescriptorNames(
         in unsigned long how_many,
         out globaldefs::NamingAttributesList_T nameList,
         out globaldefs::NamingAttributesIterator_I nameIt)
         raises(globaldefs::ProcessingFailureException);

  /** 
   * <p>This service returns the Traffic Descriptor struct for the given tdName. 
   * The Traffic Descriptor structure contains an NVSList of traffic 
   * parameters.  The traffic parameters returned will be the parameters
   * in place on the actual Traffic Descriptor.  If there are no
   * traffic parameters,
   * then the NVSList will be empty.</p><p>
   * @parm globaldefs::NamingAttributes tdName: name of the traffic descriptor.
   * @parm TrafficDescriptor_T td : the returned traffic descriptor.
   * @raises globaldefs::ProcessingFailureException<dir>
   * EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure<br>
   * EXCPT_INVALID_INPUT - Raised when tdName does not reference traficDescriptor object<br>
   * EXCPT_ENTITY_NOT_FOUND - Raised when tdName references object which does not exist<br>
   * EXCPT_NE_COMM_LOSS - Raised when communications to managedElement is lost<br>
   * </dir>
   **/
   void getTrafficDescriptor(
         in globaldefs::NamingAttributes_T tdName,
         out TrafficDescriptor_T td) 
         raises (globaldefs::ProcessingFailureException);

/**
   * <p>This allows an NMS to request all of the CTPs associated with the specified  
   * Traffic Descriptor. If there are no CTPs which are associated with the specified
   * Traffic 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.html>iterator overview</a>
   * for information on how iterators are used in this interface.</p>
   * 
   * @parm globaldefs::NamingAttributes trafficDescriptorName: the name of the Traffic 
   * Descriptor.
   * @parm  unsigned long how_many: maximum number of CTPs to return in the first batch.
   * @parm  terminationPoint::TerminationPointList tpList: first batch of CTPs.
   * @parm  terminationPoint::TerminationPointIterator_I tpIt: iterator to access the remaining
   *  CTPs.
   * @raises globaldefs::ProcessingFailureException<dir>
   * EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure<br>
   * EXCPT_INVALID_INPUT - Raised when trafficDescriptrName does not reference a
   *  Traffic Descriptor object<br>
   * EXCPT_ENTITY_NOT_FOUND - Raised when trafficDescriptorName 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>
   * </dir>
   **/
   void getAssociatedCTPs(
         in globaldefs::NamingAttributes_T trafficDescriptorName,
         in unsigned long how_many,
         out terminationPoint::TerminationPointList_T tpList,
         out terminationPoint::TerminationPointIterator_I tpIt) 
         raises(globaldefs::ProcessingFailureException);

  /**
   * <p>The createTrafficDescriptor operation is used to create
   * a new Traffic Descriptor on the server. A Traffic 
   * Descriptor create data representing the new Traffic Descriptor is 
   * passed as input. The resulting Traffic Descriptor is 
   * returned as a result.</p>
   *
   * @parm TDCreateData_T newTDCreateData: information about the traffic
   * descriptor to be created.
   * @parm TrafficDescriptor_T newTrafficDescriptor: result of the creation.
   * @raises globaldefs::ProcessingFailureException<dir>
   * EXCPT_NOT_IMPLEMENTED - Raised if EMS does not support creation of TDs via this interface<br>
   * EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure<br>
   * EXCPT_INVALID_INPUT - Raised if newTDCreateData contains invalid data<br>
   * EXCPT_USERLABEL_IN_USE - Raised when the userLabel uniqueness constraint is not met<br>
   * </dir>
   **/
   void createTrafficDescriptor(
         in  TDCreateData_T      newTDCreateData,
         out TrafficDescriptor_T newTrafficDescriptor)
         raises (globaldefs::ProcessingFailureException);


  /**
   * <p>The delete Traffic Descriptor operation is used to 
   * delete a Traffic Descriptor on the server. This operation is
   * idempotent. If the service is called with the
   * name of a non-existent Traffic Descriptor, it will succeed.</p>
   *
   * @parm globaldefs::NamingAttributes descriptorName
   * @raises globaldefs::ProcessingFailureException<dir>
   * EXCPT_NOT_IMPLEMENTED - Raised if EMS does not support deletion of TDs 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 Traffic Descriptor<br>
   * </dir>
  **/
   void deleteTrafficDescriptor(
         in globaldefs::NamingAttributes_T descriptorName)
         raises (globaldefs::ProcessingFailureException);
};

}; // END OF MODULE

#endif