Interface CosNotifyFilter::FilterAdmin

interface FilterAdmin

The FilterAdmin interface supports the management of filter objects.



Operation Index

add_filter
Adds a filter to the target object.
get_all_filters
Retrieve a list of all filters associated with the target object.
get_filter
Retrieves a reference for the filter with the given filter ID from the target object.
remove_all_filters
Remove all filters associated with the target object.
remove_filter
Remove a filter from the target object, the filter itself is not destroyed.

Operations

add_filter
FilterID add_filter(in Filter new_filter);

Adds a filter to the target object.

Parameters:
new_filter - The filter object to be added to the target object.
Returns:
The ID assigned to the filter by the target object is returned.

get_all_filters
FilterIDSeq get_all_filters();

Retrieve a list of all filters associated with the target object.

Returns:
A list of filter IDs is returned.

get_filter
Filter get_filter(in FilterID filter)
    raises(FilterNotFound);

Retrieves a reference for the filter with the given filter ID from the target object.

Parameters:
filter - The ID of the filter to locate.
Returns:
A reference to a filter object is returned. If a filter with a given ID could not a be found a FilterNotFound exception is raised.

remove_all_filters
void remove_all_filters();

Remove all filters associated with the target object.


remove_filter
void remove_filter(in FilterID filter)
    raises(FilterNotFound);

Remove a filter from the target object, the filter itself is not destroyed. If the specified filter is not found a FilterNotFound exception is raised.

Parameters:
filter - The ID of the filter to remove.


Generated by the ORBacus IDL-to-HTML translator (non-commercial)