1CosNotifyFilter_MappingFilteErr(l3a)ng Module DefiniCtoisoNnotifyFilter_MappingFilter(3)
2
3
4

NAME

6       CosNotifyFilter_MappingFilter - This module implements the OMG CosNoti‐
7       fyFilter::MappingFilter interface.
8

DESCRIPTION

10       The main purpose of this module is to match events  against  associated
11       constraints  and return the value for the first constraint that returns
12       true for the given event. If all constraints return false  the  default
13       value will be returned.
14
15       To get access to the record definitions for the structures use:
16       -include_lib("cosNotification/include/*.hrl").
17

EXPORTS

19       _get_constraint_grammar(MappingFilter) -> Grammar
20
21              Types:
22
23                 MappingFilter = #objref
24                 Grammar = string()
25
26              This  operation  returns which type of Grammar the MappingFilter
27              uses. Currently, only "EXTENDED_TCL" is supported.
28
29       _get_value_type(MappingFilter) -> CORBA::TypeCode
30
31              Types:
32
33                 MappingFilter = #objref
34
35              This readonly attribute maintains the CORBA::TypeCode of the de‐
36              fault value associated with the target object.
37
38       _get_default_value(MappingFilter) -> #any
39
40              Types:
41
42                 MappingFilter = #objref
43
44              This readonly attribute maintains the #any{} default value asso‐
45              ciated with the target object.
46
47       add_mapping_constraints(MappingFilter, MappingConstraintPairSeq) -> Re‐
48       ply
49
50              Types:
51
52                 MappingFilter = #objref
53                 MappingConstraintPairSeq = [MappingConstraintPair]
54                 MappingConstraintPair  = #'CosNotifyFilter_MappingConstraint‐
55                 Pair'{constraint_expression, result_to_set}
56                 constraint_expression     =     #'CosNotifyFilter_Constraint‐
57                 Exp'{event_types, constraint_expr}
58                 event_types = #'CosNotification_EventTypeSeq'{}
59                 constraint_expr = string()
60                 result_to_set = #any
61                 Reply = MappingConstraintInfoSeq | {'EXCEPTION', #'CosNotify‐
62                 Filter_InvalidConstraint'{constr}} | {'EXCEPTION', #'CosNoti‐
63                 fyFilter_InvalidValue'{constr, value}}
64                 constr = ConstraintExp
65                 ConstraintExp = #'CosNotifyFilter_ConstraintExp'{event_types,
66                 constraint_expr}
67                 event_types = #'CosNotification_EventTypeSeq'{}
68                 constraint_expr = string()
69                 MappingConstraintInfoSeq = [MappingConstraintInfo]
70                 MappingConstraintInfo     =     #'CosNotifyFilter_MappingCon‐
71                 straintInfo'{constraint_expression, constraint_id, value}
72                 constraint_expression = ConstraintExp
73                 constraint_id = long()
74                 value = #any
75
76              This  operation  add new mapping constraints, which will be used
77              when trying to override Quality of Service settings  defined  in
78              the  given  event.  If  a  constraint return true the associated
79              value will be returned, otherwise the default value.
80
81       modify_constraints(MappingFilter, ConstraintIDSeq, MappingConstraintIn‐
82       foSeq) -> Reply
83
84              Types:
85
86                 MappingFilter = #objref
87                 ConstraintIDSeq = [ConstraintID]
88                 ConstraintID = long()
89                 MappingConstraintInfoSeq = [MappingConstraintInfo]
90                 MappingConstraintInfo     =     #'CosNotifyFilter_MappingCon‐
91                 straintInfo'{constraint_expression, constraint_id, value}
92                 constraint_expression = ConstraintExp
93                 constraint_id = long()
94                 value = #any
95                 ConstraintInfoSeq = [ConstraintInfo]
96                 ConstraintInfo    =    #'CosNotifyFilter_ConstraintInfo'{con‐
97                 straint_expression, constraint_id}
98                 constraint_expression = ConstraintExp
99                 constraint_id = long()
100                 Reply  =  ok  |  {'EXCEPTION',  #'CosNotifyFilter_InvalidCon‐
101                 straint'{constr}}  |   {'EXCEPTION',   #'CosNotifyFilter_Con‐
102                 straintNotFound'{id}}  |  {'EXCEPTION', #'CosNotifyFilter_In‐
103                 validValue'{constr, value}}
104                 constr = ConstraintExp
105                 id = long()
106                 value = #any
107                 ConstraintExp = #'CosNotifyFilter_ConstraintExp'{event_types,
108                 constraint_expr}
109                 event_types = #'CosNotification_EventTypeSeq'{}
110                 constraint_expr = string()
111
112              The  ConstraintIDSeq  supplied  should relate to constraints the
113              caller wishes to remove. If any of the  supplied  Id's  are  not
114              found an exception will be raised. This operation also accepts a
115              sequence of MappingConstraintInfo which will be  added.  If  the
116              target  object cannot modify the constraints as requested an ex‐
117              ception is raised describing which constraint,  and  why,  could
118              not be updated.
119
120       get_mapping_constraints(MappingFilter, ConstraintIDSeq) -> Reply
121
122              Types:
123
124                 MappingFilter = #objref
125                 ConstraintIDSeq = [ConstraintID]
126                 ConstraintID = long()
127                 Reply = MappingConstraintInfoSeq | {'EXCEPTION', #'CosNotify‐
128                 Filter_ConstraintNotFound'{id}}
129                 MappingConstraintInfoSeq = [MappingConstraintInfo]
130                 MappingConstraintInfo     =     #'CosNotifyFilter_MappingCon‐
131                 straintInfo'{constraint_expression, constraint_id, value}
132                 constraint_expression = ConstraintExp
133                 ConstraintExp = #'CosNotifyFilter_ConstraintExp'{event_types,
134                 constraint_expr}
135                 event_types = #'CosNotification_EventTypeSeq'{}
136                 constraint_expr = string()
137                 constraint_id = id = long()
138                 value = #any
139
140              When adding a new constraint a unique Id is returned,  which  is
141              accepted  as input for this operation. The associated constraint
142              is returned, but if no such Id exists an exception is raised.
143
144       get_all_mapping_constraints(MappingFilter) -> MappingConstraintInfoSeq
145
146              Types:
147
148                 MappingFilter = #objref
149                 MappingConstraintInfoSeq = [MappingConstraintInfo]
150                 MappingConstraintInfo     =     #'CosNotifyFilter_MappingCon‐
151                 straintInfo'{constraint_expression, constraint_id, value}
152                 constraint_expression = ConstraintExp
153                 ConstraintExp = #'CosNotifyFilter_ConstraintExp'{event_types,
154                 constraint_expr}
155                 event_types = #'CosNotification_EventTypeSeq'{}
156                 constraint_expr = string()
157                 constraint_id = long()
158                 value = #any
159
160              This operation returns a sequence of all unique Id's  associated
161              with the target object. If no constraint have been added the se‐
162              quence will be empty.
163
164       remove_all_mapping_constraints(MappingFilter) -> ok
165
166              Types:
167
168                 MappingFilter = #objref
169
170              This operation removes all constraints associated with the  tar‐
171              get object.
172
173       destroy(MappingFilter) -> ok
174
175              Types:
176
177                 MappingFilter = #objref
178
179              This  operation terminates the target object. Remember to remove
180              this Filter from the objects it have been associated with.
181
182       match(MappingFilter, Event) -> Reply
183
184              Types:
185
186                 MappingFilter = #objref
187                 Event = #any
188                 Reply = {boolean(),  #any}  |  {'EXCEPTION',  #'CosNotifyFil‐
189                 ter_UnsupportedFilterableData'{}}
190
191              This  operation  evaluates  Any  events  with  the Filter's con‐
192              straints, and returns the value to use. The value is the default
193              value  if all constraints returns false and the value associated
194              with the first constraint returning true.
195
196       match_structured(MappingFilter, Event) -> Reply
197
198              Types:
199
200                 MappingFilter = #objref
201                 Event = #'CosNotification_StructuredEvent'{}
202                 Reply = {boolean(),  #any}  |  {'EXCEPTION',  #'CosNotifyFil‐
203                 ter_UnsupportedFilterableData'{}}
204
205              Similar to match/2 but accepts a structured event as input.
206
207
208
209Ericsson AB                  cosNotification 5.C0o.s2NotifyFilter_MappingFilter(3)