org.omg.CosNotifyFilter
Interface FilterAdminOperations
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.
|
public 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
public 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
public
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. 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: org.omg.CosNotifyFilter.FilterNotFound Id doesn't match to any filter
public 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.
public 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.
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: org.omg.CosNotifyFilter.FilterNotFound Id doesn't match to any filter