cosnotifyfilter.idl

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

       * @parm <code>callback</code> - ID of the callback object to detach.
       * @raises CallbackNotFound If the ID does not correspond to any
       * attached callback object reference.
       */
      void detach_callback ( in CallbackID callback)
	 raises ( CallbackNotFound );

      /**
       * Returns a list of callback objects attached to this filter.
       * @returns List of callback object IDs.
       */
      CallbackIDSeq get_callbacks();

   }; // Filter

   /**
    * Interface for a mapping filter.
    */
   interface MappingFilter
   {
      /**
       * The constraint grammer used by this filter.
       */
      readonly attribute string constraint_grammar;

      /**
       * The data type of the property value that this filter was designed
       * to affect.
       */
#ifdef ORBIX23
      readonly attribute CORBA::TypeCode value_type;
#else
#endif
      /**
       * The output value for any match operation that returns true.
       */
      readonly attribute any default_value;

      /**
       * Associates one or more mapping constraints with this filter object.
       * @parm <code>constraint_list</code> - List of mapping constraints to
       * be associated with filter.
       * @returns A list with ID for each of the added mapping constraints.
       * @raises InvalidConstraint If any of the mapping constraints
       * are invalid.
       * @raises InvalidValue If any of the constraints have a typecode
       * that is different from the <code>value_type</code> attribute.
       */
      MappingConstraintInfoSeq add_mapping_constraints (
	 in MappingConstraintPairSeq pair_list)
	 raises (InvalidConstraint, InvalidValue);

      /**
       * Delete or modify mapping constraints on this filter object.
       * @parm <code>del_list</code> - List of mapping constraints to delete.
       * @parm <code>modify_list</code> - List of constraints to modify.
       * @raises InvalidConstraint If any of the constraints in the
       * modify_list input sequences are invalid.
       * @raises InvalidValue If any of the constraints have a typecode
       * that is different from the <code>value_type</code> attribute.
       * @raises ConstraintNotFound If a constraint in either
       * of the two input sequences was not found.
       */
      void modify_mapping_constraints (
	 in ConstraintIDSeq del_list,
	 in MappingConstraintInfoSeq modify_list)
	 raises (InvalidConstraint, InvalidValue,
		 ConstraintNotFound);

      /**
       * Return a list of mapping constraints for this filter object
       * based on IDs.
       * @parm <code>id_list</code> - List of mapping constraint IDs.
       * @returns A list of mapping constraints for the IDs in the
       * input sequence.
       * @raises ConstraintNotFound If a mapping constraint was not found.
       */
      MappingConstraintInfoSeq get_mapping_constraints (
	 in ConstraintIDSeq id_list)
	 raises (ConstraintNotFound);

      /**
       * Return a list of all mapping constraints for this filter object.
       * @returns A list of all mapping constraints.
       */
      MappingConstraintInfoSeq get_all_mapping_constraints();

      /**
       * Removes all mapping constraints defined on this filter object.
       */
      void remove_all_mapping_constraints();

      /**
       * Destroys this mapping filter object.
       */
      void destroy();

      /**
       * Evaluates the input event against the filter constraints defined
       * on this filter object. If the event satisfies one of the filter
       * constraints TRUE is returned, otherwise FALSE is returned.
       * @parm <code>filterable_data</code> - The event to evaluate.
       * @parm <code>result_to_set</code> - Value of a constraint that
       * matches the event or <code>default_value</code> if the event
       * does not match any constraints.
       * @returns TRUE if event matches any constraint, FALSE otherwise.
       * raises UnsupportedFilterableData If the event specified by
       * <code>filterable_data</code> contains data that this filter is
       * not designed to handle.
       */
      boolean match ( in any filterable_data,
		      out any result_to_set )
	 raises (UnsupportedFilterableData);

      /**
       * Evaluates the input event against the filter constraints defined
       * on this filter object. If the event satisfies one of the filter
       * constraints TRUE is returned, otherwise FALSE is returned.
       * @parm <code>filterable_data</code> - The structured event to evaluate.
       * @parm <code>result_to_set</code> - Value of a constraint that
       * matches the event or <code>default_value</code> if the event
       * does not match any constraints.
       * @returns TRUE if event matches any constraint, FALSE otherwise.
       * raises UnsupportedFilterableData If the event specified by
       * <code>filterable_data</code> contains data that this filter is
       * not designed to handle.
       */
      boolean match_structured (
	 in CosNotification::StructuredEvent filterable_data,
	 out any result_to_set)
	 raises (UnsupportedFilterableData);

      /**
       * Evaluates the input event against the filter constraints defined
       * on this filter object. If the event satisfies one of the filter
       * constraints TRUE is returned, otherwise FALSE is returned.
       * @parm <code>filterable_data</code> - The typed event to evaluate.
       * @parm <code>result_to_set</code> - Value of a constraint that
       * matches the event or default_value if the event does not match
       * any constraints.
       * @returns TRUE if event matches any constraint, FALSE otherwise.
       * raises UnsupportedFilterableData If the event specified by
       * <code>filterable_data</code> contains data that this filter is
       * not designed to handle.
       */
      boolean match_typed (
	 in CosNotification::PropertySeq filterable_data,
	 out any result_to_set)
	 raises (UnsupportedFilterableData);

   }; // MappingFilter

   /**
    * Interface for a filter factory.
    */
   interface FilterFactory
   {
      /**
       * Create a filter with the specified grammer.
       * @parm <code>constraint_grammar</code> - The constraint grammer to
       * be used by the filter.
       * @returns A filter object reference.
       * @raises InvalidGrammar If the specified grammer is not supported.
       */
      Filter create_filter (
	 in string constraint_grammar)
	 raises (InvalidGrammar);

      /**
       * Create a mapping filter with the specified grammer.
       * @parm <code>constraint_grammar</code> - The constraint grammer to
       * be used by the filter.
       * @parm <code>default_value</code> - The default value to be returned
       * by match operations invoked on the mapping filter if no match is
       * found.
       * @returns A mapping filter object reference.
       * @raises InvalidGrammar If the specified grammer is not supported.
       */
      MappingFilter create_mapping_filter (
	 in string constraint_grammar,
	 in any default_value)
	 raises(InvalidGrammar);

   }; // FilterFactory

   /**
    * A unique identifier used to identify filters.
    */
   typedef long FilterID;

   /**
    * A sequence of FilterID.
    */
   typedef sequence<FilterID> FilterIDSeq;

   /**
    * Exception used when a filter could not be found.
    */
   exception FilterNotFound {};

   /**
    * Interface for filter administrators.
    */
   interface FilterAdmin
   {
      /**
       * Add a filter to this object's list of filters. All these filters
       * are tried upon reception of an event.
       * @parm <code>new_filter</code> - The filter to add.
       * @returns An unique ID that identifies the added filter.
       */
      FilterID add_filter ( in Filter new_filter );

      /**
       * Remove a filter from this object's list of filters.
       * @parm <code>filter</code> - The filter ID.
       * @raises FilterNotFound If the ID does not correspond to any
       * filter that has been added to this object.
       */
      void remove_filter ( in FilterID filter )
	 raises ( FilterNotFound );

      /**
       * Get a filter from the filter ID.
       * @parm <code>filter</code> - The filter ID.
       * @raises FilterNotFound If the ID does not correspond to any
       * filter that has been added to this object.
       */
      Filter get_filter ( in FilterID filter )
	 raises ( FilterNotFound );

      /**
       * Get all filters added to this administration object.
       * @returns A sequence of filter IDs.
       */
      FilterIDSeq get_all_filters();

      /**
       * Remove all filters added to this administration object.
       */
      void remove_all_filters();

   }; // FilterAdmin

}; // CosNotifyFilter

#endif /* COSNOTIFYFILTER_IDL */