org.omg.CosNotifyFilter
Interface FilterAdminOperations

All Known Subinterfaces:
ConsumerAdmin, ConsumerAdminOperations, FilterAdmin, ProxyConsumer, ProxyConsumerOperations, ProxyPullConsumer, ProxyPullConsumerOperations, ProxyPullSupplier, ProxyPullSupplierOperations, ProxyPushConsumer, ProxyPushConsumerOperations, ProxyPushSupplier, ProxyPushSupplierOperations, ProxySupplier, ProxySupplierOperations, SequenceProxyPullConsumer, SequenceProxyPullConsumerOperations, SequenceProxyPullSupplier, SequenceProxyPullSupplierOperations, SequenceProxyPushConsumer, SequenceProxyPushConsumerOperations, SequenceProxyPushSupplier, SequenceProxyPushSupplierOperations, StructuredProxyPullConsumer, StructuredProxyPullConsumerOperations, StructuredProxyPullSupplier, StructuredProxyPullSupplierOperations, StructuredProxyPushConsumer, StructuredProxyPushConsumerOperations, StructuredProxyPushSupplier, StructuredProxyPushSupplierOperations, SupplierAdmin, SupplierAdminOperations, TypedConsumerAdmin, TypedConsumerAdminOperations, TypedProxyPullConsumer, TypedProxyPullConsumerOperations, TypedProxyPullSupplier, TypedProxyPullSupplierOperations, TypedProxyPushConsumer, TypedProxyPushConsumerOperations, TypedProxyPushSupplier, TypedProxyPushSupplierOperations, TypedSupplierAdmin, TypedSupplierAdminOperations
All Known Implementing Classes:
_ConsumerAdminStub, _FilterAdminStub, _ProxyConsumerStub, _ProxyPullConsumerStub, _ProxyPullSupplierStub, _ProxyPushConsumerStub, _ProxyPushSupplierStub, _ProxySupplierStub, _SequenceProxyPullConsumerStub, _SequenceProxyPullSupplierStub, _SequenceProxyPushConsumerStub, _SequenceProxyPushSupplierStub, _StructuredProxyPullConsumerStub, _StructuredProxyPullSupplierStub, _StructuredProxyPushConsumerStub, _StructuredProxyPushSupplierStub, _SupplierAdminStub, _TypedConsumerAdminStub, _TypedProxyPullConsumerStub, _TypedProxyPullSupplierStub, _TypedProxyPushConsumerStub, _TypedProxyPushSupplierStub, _TypedSupplierAdminStub, ConsumerAdminImpl, ConsumerAdminPOA, ConsumerAdminPOATie, FilterAdminPOA, FilterAdminPOATie, ProxyConsumerPOA, ProxyConsumerPOATie, ProxyPullConsumerImpl, ProxyPullConsumerPOA, ProxyPullConsumerPOATie, ProxyPullSupplierImpl, ProxyPullSupplierPOA, ProxyPullSupplierPOATie, ProxyPushConsumerImpl, ProxyPushConsumerPOA, ProxyPushConsumerPOATie, ProxyPushSupplierImpl, ProxyPushSupplierPOA, ProxyPushSupplierPOATie, ProxySupplierPOA, ProxySupplierPOATie, SequenceProxyPullConsumerImpl, SequenceProxyPullConsumerPOA, SequenceProxyPullConsumerPOATie, SequenceProxyPullSupplierImpl, SequenceProxyPullSupplierPOA, SequenceProxyPullSupplierPOATie, SequenceProxyPushConsumerImpl, SequenceProxyPushConsumerPOA, SequenceProxyPushConsumerPOATie, SequenceProxyPushSupplierImpl, SequenceProxyPushSupplierPOA, SequenceProxyPushSupplierPOATie, StructuredProxyPullConsumerImpl, StructuredProxyPullConsumerPOA, StructuredProxyPullConsumerPOATie, StructuredProxyPullSupplierImpl, StructuredProxyPullSupplierPOA, StructuredProxyPullSupplierPOATie, StructuredProxyPushConsumerImpl, StructuredProxyPushConsumerPOA, StructuredProxyPushConsumerPOATie, StructuredProxyPushSupplierImpl, StructuredProxyPushSupplierPOA, StructuredProxyPushSupplierPOATie, SupplierAdminImpl, SupplierAdminPOA, SupplierAdminPOATie, TypedConsumerAdminPOA, TypedConsumerAdminPOATie, TypedProxyPullConsumerPOA, TypedProxyPullConsumerPOATie, TypedProxyPullSupplierPOA, TypedProxyPullSupplierPOATie, TypedProxyPushConsumerPOA, TypedProxyPushConsumerPOATie, TypedProxyPushSupplierPOA, TypedProxyPushSupplierPOATie, TypedSupplierAdminPOA, TypedSupplierAdminPOATie

public interface FilterAdminOperations

The FilterAdmin interface defines operations that enable an object supporting this interface to manage a list of filter objects, each of which supports the Filter interface. This interface is intended to be an abstract interface which is inherited by all of the Proxy and Admin interfaces defined by the Notification Service. The difference in the semantics between a list of filter objects that is associated with an Admin object, and a list that is associated with a Proxy object, is described in section 2.1.2 of the specifiaction.


Method Summary
 int add_filter(Filter new_filter)
          The add_filter operation accepts as input the reference to an object supporting the Filter interface.
 int[] get_all_filters()
          The get_all_filters operation accepts no input parameters, and returns the list of unique identifiers which correspond to all of the filters currently associated with the target object.
 Filter get_filter(int filter)
          The get_filter operation accepts as input a numeric identifier that is intended to correspond to one of the filter objects currently associated with the target object.
 void remove_all_filters()
          The remove_all_filters operation accepts no input parameters, and removes all filter objects from the list of those currently associated with the target object.
 void remove_filter(int filter)
          The remove_filter operation accepts as input a numeric value that is intended to be the unique identifier of a filter object that is currently associated with the target object.
 

Method Detail

add_filter

int add_filter(Filter new_filter)
The add_filter operation accepts as input the reference to an object supporting the Filter interface. The affect of this operation is that the input filter object is appended to the list of filter objects associated with the target object upon which the operation was invoked. The operation associates with the newly added filter object a numeric identifier that is unique among all filter objects currently associated with the target, and returns that value as the result of the operation.

Parameters:
new_filter - filter to add
Returns:
filter id

remove_filter

void remove_filter(int filter)
                   throws FilterNotFound
The remove_filter operation accepts as input a numeric value that is intended to be the unique identifier of a filter object that is currently associated with the target object. If the identifier supplied does correspond to a filter object currently associated with the target object, then the corresponding filter object will be removed from the list of filters associated with the target object. Otherwise, the FilterNotFound exception will be raised.

Parameters:
filter - Id of the filter
Throws:
FilterNotFound - Id doesn't match to any filter

get_filter

Filter get_filter(int filter)
                  throws FilterNotFound
The get_filter operation accepts as input a numeric identifier that is intended to correspond to one of the filter objects currently associated with the target object. If this is the case, the object reference of the corresponding filter object is returned. Otherwise, the FilterNotFound exception is raised.

Parameters:
filter - Id of the filter to get
Returns:
The filter object
Throws:
FilterNotFound - Id doesn't match to any filter

get_all_filters

int[] get_all_filters()
The get_all_filters operation accepts no input parameters, and returns the list of unique identifiers which correspond to all of the filters currently associated with the target object.

Returns:
Array of all filters's id

remove_all_filters

void remove_all_filters()
The remove_all_filters operation accepts no input parameters, and removes all filter objects from the list of those currently associated with the target object.