1CosNotifyFilter_FilterAdmin(E3r)lang Module DefinitiCoonsNotifyFilter_FilterAdmin(3)
2
3
4
6 CosNotifyFilter_FilterAdmin - This module implements the OMG CosNotify‐
7 Filter::FilterAdmin interface.
8
10 To get access to the record definitions for the structures use:
11 -include_lib("cosNotification/include/*.hrl").
12
13 All objects, which inherit this interface, export functions described
14 in this module.
15
17 add_filter(Object, Filter) -> FilterID
18
19 Types:
20
21 Object = #objref
22 Filter = #objref
23 FilterID = long()
24
25 This operation connects a new Filter to the target object. This
26 Filter will, together with other associated Filters, be used to
27 select events to forward. A unique Id is returned and should be
28 used if we no longer want to consult the given Filter.
29
30 remove_filter(Object, FilterID) -> ok
31
32 Types:
33
34 Object = #objref
35 FilterID = long()
36
37 If a certain Filter no longer should be associated with the tar‐
38 get object this operation must be used. Events will no longer be
39 tested against the Filter associated with the given Id.
40
41 get_filter(Object, FilterID) -> Reply
42
43 Types:
44
45 Object = #objref
46 FilterID = long()
47 Reply = Filter | {'EXCEPTION', #'CosNotifyFilter_FilterNot‐
48 Found'{}}
49 Filter = #objref
50
51 If the target object is associated with a Filter matching the
52 given Id the reference will be returned. If no such Filter is
53 known by the target object an exception is raised.
54
55 get_all_filters(Object) -> FilterIDSeq
56
57 Types:
58
59 Object = #objref
60 FilterIDSeq = [FilterID]
61 FilterID = long()
62
63 Id's for all Filter objects associated with the target object is
64 returned by this operation.
65
66 remove_all_filters(Object) -> ok
67
68 Types:
69
70 Object = #objref
71
72 If we want to remove all Filters associated with the target ob‐
73 ject we can use this function.
74
75
76
77Ericsson AB cosNotification 5.0.C2osNotifyFilter_FilterAdmin(3)