1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
|
.TH CosPropertyService_PropertySetDef 3 "cosProperty 1.1.6" "Ericsson AB" "ERLANG MODULE DEFINITION"
.SH MODULE
CosPropertyService_PropertySetDef \- This module implements the OMG CosPropertyService::PropertySetDef interface\&.
.SH DESCRIPTION
.LP
To get access to the record definitions for the structures use:
.br
\fI-include_lib("cosProperty/include/CosPropertyService\&.hrl")\&.\fR
.LP
This module also exports the functions described in
.LP
CosPropertyService_PropertySet
.SH EXPORTS
.LP
.B
get_allowed_property_types(PropertySetDef) -> Reply
.br
.RS
.TP
Types
PropertySetDef = #objref
.br
Reply = {ok, PropertyTypes}
.br
PropertyTypes = [CORBA::TypeCode]
.br
.RE
.RS
.LP
This operation return the TypeCodes which we are allowed to use when adding new properties\&.
.RE
.LP
.B
get_allowed_properties(PropertySetDef) -> Reply
.br
.RS
.TP
Types
PropertySetDef = #objref
.br
Reply = {ok, PropertyDefs}
.br
PropertyDefs = [#\&'CosPropertyService_PropertyDef\&'{property_name = Name, property_value = Value, property_mode = Mode}]
.br
Name = string()
.br
Value = #any
.br
Mode = normal | read_only | fixed_normal | fixed_readonly | undefined
.br
.RE
.RS
.LP
This operation a sequence of the allowed properties we may alter; depends on which mode associated with a certain property\&.
.RE
.LP
.B
define_property_with_mode(PropertySetDef, Name, Value, Mode) -> Reply
.br
.RS
.TP
Types
PropertySetDef = #objref
.br
Name = non-empty string()
.br
Value = #any
.br
Mode = normal | read_only | fixed_normal | fixed_readonly | undefined
.br
Reply = ok | {\&'EXCEPTION\&', #CosPropertyService_InvalidPropertyName{}} | {\&'EXCEPTION\&', #CosPropertyService_ConflictingProperty{}} | {\&'EXCEPTION\&', #CosPropertyService_UnsupportedTypeCode{}} | {\&'EXCEPTION\&', #CosPropertyService_UnsupportedProperty{}} | {\&'EXCEPTION\&', #CosPropertyService_UnsupportedMode{}} | {\&'EXCEPTION\&', #CosPropertyService_ReadOnlyProperty{}}
.br
.RE
.RS
.LP
This operation attempts to associate a new property with the target object\&. If we fail to do so the appropriate exception is raised\&.
.RE
.LP
.B
define_properties_with_modes(PropertySetDef, PropertyDefs) -> Reply
.br
.RS
.TP
Types
PropertySetDef = #objref
.br
PropertyDefs = [#\&'CosPropertyService_PropertyDef\&'{property_name = Name, property_value = Value, property_mode = Mode}]
.br
Name = string()
.br
Value = #any
.br
Mode = normal | read_only | fixed_normal | fixed_readonly | undefined
.br
Reply = ok | {\&'EXCEPTION\&', #CosPropertyService_MultipleExceptions{exceptions = Excs}}
.br
Excs = [#\&'CosPropertyService_PropertyException{reason = Reason, failing_property_name = Name}]
.br
Reason = invalid_property_name | conflicting_property | property_not_found | unsupported_type_code | unsupported_property | unsupported_mode | fixed_property | read_only_property
.br
.RE
.RS
.LP
This operation attempts to associate the given Property Definitions with the target object\&. If one or more attempts fail an exception is raised describing which properties we where not able to create\&.
.RE
.LP
.B
get_property_mode(PropertySetDef, Name) -> Reply
.br
.RS
.TP
Types
PropertySetDef = #objref
.br
Name = string()
.br
Reply = Mode | {\&'EXCEPTION\&', #CosPropertyService_InvalidPropertyName{}} | {\&'EXCEPTION\&', #CosPropertyService_PropertyNotFound{}}
.br
Mode = normal | read_only | fixed_normal | fixed_readonly | undefined
.br
.RE
.RS
.LP
This operation returns the type of the given property\&.
.RE
.LP
.B
get_property_modes(PropertySetDef, Names) -> Reply
.br
.RS
.TP
Types
PropertySetDef = #objref
.br
Names = [string()]
.br
Reply = {boolean(), PropertyModes}
.br
PropertyModes = [#\&'CosPropertyService_PropertyMode\&'{property_name = Name, property_mode = Mode}]
.br
Name = string()
.br
Mode = normal | read_only | fixed_normal | fixed_readonly | undefined
.br
.RE
.RS
.LP
This operation returns the modes of the listed properties\&. If the boolean flag is false, all properties with mode \fIundefined\fR this operation failed to comply\&.
.RE
.LP
.B
set_property_mode(PropertySetDef, Name, Mode) -> Reply
.br
.RS
.TP
Types
PropertySetDef = #objref
.br
Name = string()
.br
Mode = normal | read_only | fixed_normal | fixed_readonly | undefined
.br
Reply = ok | {\&'EXCEPTION\&', #CosPropertyService_InvalidPropertyName{}} | {\&'EXCEPTION\&', #CosPropertyService_UnsupportedMode{}} | {\&'EXCEPTION\&', #CosPropertyService_PropertyNotFound{}}
.br
.RE
.RS
.LP
This operation changes the given property\&'s mode\&. Return the appropriate exception if not able to fulfill the request\&.
.RE
.LP
.B
set_property_modes(PropertySetDef, PropertyModes) -> Reply
.br
.RS
.TP
Types
PropertySetDef = #objref
.br
PropertyModes = [#\&'CosPropertyService_PropertyMode\&'{property_name = Name, property_mode = Mode}]
.br
Name = string()
.br
Mode = normal | read_only | fixed_normal | fixed_readonly | undefined
.br
Reply = ok | {\&'EXCEPTION\&', #CosPropertyService_MultipleExceptions{exceptions = Excs}}
.br
Excs = [#\&'CosPropertyService_PropertyException{reason = Reason, failing_property_name = Name}]
.br
Reason = invalid_property_name | conflicting_property | property_not_found | unsupported_type_code | unsupported_property | unsupported_mode | fixed_property | read_only_property
.br
.RE
.RS
.LP
This operation attempts to update the listed properties mode\&'s\&. Raises an exception which describe which and why an operation failed\&.
.RE
|
