CosNotifyFilter::FilterAdmin Interface Reference
Interface used to modify the Filters attached to a Notification Service component. More...
import "CosNotifyFilter.idl";
Inheritance diagram for CosNotifyFilter::FilterAdmin:
Public Member Functions | |
| FilterID | add_filter (in Filter new_filter) |
| Add a filter. | |
| void | remove_filter (in FilterID filter) raises ( FilterNotFound ) |
| Remove a filter. | |
| Filter | get_filter (in FilterID filter) raises ( FilterNotFound ) |
| Get a filter. | |
| FilterIDSeq | get_all_filters () |
| Get the IDs of all the filters. | |
| void | remove_all_filters () |
| Remove all the filters from this component. | |
Detailed Description
Interface used to modify the Filters attached to a Notification Service component.Member Function Documentation
| void CosNotifyFilter::FilterAdmin::remove_filter | ( | in FilterID | filter | ) | raises ( FilterNotFound ) |
Remove a filter.
- Parameters:
-
filter ID of the filter to be removed
- Exceptions:
-
FilterNotFound if the filter ID is not found in this FilterAdmin
| Filter CosNotifyFilter::FilterAdmin::get_filter | ( | in FilterID | filter | ) | raises ( FilterNotFound ) |
Get a filter.
- Parameters:
-
filter ID of the filter returned
- Returns:
- The filter
- Exceptions:
-
FilterNotFound if the filter ID is not found in this FilterAdmin
| FilterIDSeq CosNotifyFilter::FilterAdmin::get_all_filters | ( | ) |
Get the IDs of all the filters.
- Returns:
- The list of all filter IDs in this component
| void CosNotifyFilter::FilterAdmin::remove_all_filters | ( | ) |
Remove all the filters from this component.
The documentation for this interface was generated from the following file:
