1CosPropertyService_PropertySEertl(a3n)g Module DefinCiotsiPornopertyService_PropertySet(3)
2
3
4

NAME

6       CosPropertyService_PropertySet   -   This  module  implements  the  OMG
7       CosPropertyService::PropertySet interface.
8

DESCRIPTION

10       To get access to the record definitions for the structures use:
11       -include_lib("cosProperty/include/CosPropertyService.hrl").
12

EXPORTS

14       define_property(PropertySet, Name, Value) -> Reply
15
16              Types:
17
18                 PropertySet = #objref
19                 Name = non-empty string()
20                 Value = #any
21                 Reply = ok | {'EXCEPTION', #CosPropertyService_InvalidProper‐
22                 tyName{}}  |  {'EXCEPTION',  #CosPropertyService_Conflicting‐
23                 Property{}} | {'EXCEPTION',  #CosPropertyService_Unsupported‐
24                 TypeCode{}}  | {'EXCEPTION', #CosPropertyService_Unsupported‐
25                 Property{}} | {'EXCEPTION', #CosPropertyService_ReadOnlyProp‐
26                 erty{}}
27
28              This  operation adds a new property to the given object. Depend‐
29              ing on which initial arguments was supplied  when  starting  the
30              object several exceptions may be raised.
31
32       define_properties(PropertySet, Properties) -> Reply
33
34              Types:
35
36                 PropertySet = #objref
37                 Properties  = [#'CosPropertyService_Property'{property_name =
38                 Name, property_value = Value}]
39                 Name = string()
40                 Value = #any
41                 Reply = ok | {'EXCEPTION', #CosPropertyService_MultipleExcep‐
42                 tions{exceptions = Excs}}
43                 Excs  = [#'CosPropertyService_PropertyException{reason = Rea‐
44                 son, failing_property_name = Name}]
45                 Reason = invalid_property_name | conflicting_property | prop‐
46                 erty_not_found | unsupported_type_code | unsupported_property
47                 | unsupported_mode | fixed_property | read_only_property
48
49              This operation adds several new properties to the given  object.
50              Depending  on which initial arguments was supplied when starting
51              the object an exceptions may be raised  listing  the  properties
52              failing.
53
54       get_number_of_properties(PropertySet) -> ulong()
55
56              Types:
57
58                 PropertySet = #objref
59
60              This  operation returns the number of properties associated with
61              the target object.
62
63       get_all_property_names(PropertySet, Max) -> Reply
64
65              Types:
66
67                 PropertySet = NamesIterator = #objref
68                 Max = ulong()
69                 Reply = {ok, Names, NamesIterator}
70                 Names = [string()]
71
72              This operation returns up to Max property names. If  the  target
73              object have additional associated properties they will be put in
74              the returned Iterator, otherwise the Iterator will be a NIL  ob‐
75              ject.
76
77       get_property_value(PropertySet, Name) -> Reply
78
79              Types:
80
81                 PropertySet = #objref
82                 Name = string()
83                 Reply = #any | {'EXCEPTION', #CosPropertyService_PropertyNot‐
84                 Found{}} | {'EXCEPTION', #CosPropertyService_InvalidProperty‐
85                 Name{}}
86
87              This  operation returns the property value associated with given
88              name. If no such property exists or the given name is  an  empty
89              string an exception will be raised.
90
91       get_properties(PropertySet, Names) -> Reply
92
93              Types:
94
95                 PropertySet = #objref
96                 Names = [string()]
97                 Reply = {boolean(), Properties}
98                 Properties  = [#'CosPropertyService_Property'{property_name =
99                 Name, property_value = Value}]
100
101              This operation returns  all  properties  associated  with  given
102              names.  If  the  boolean  flag  is true all properties where re‐
103              trieved correctly,  otherwise,  all  properties  with  the  type
104              tk_void was not found.
105
106       get_all_properties(PropertySet, Max) -> Reply
107
108              Types:
109
110                 PropertySet = PropertiesIterator = #objref
111                 Reply = {ok, Properties, PropertiesIterator}
112                 Properties  = [#'CosPropertyService_Property'{property_name =
113                 Name, property_value = Value}]
114
115              This operation return a list Max properties  or  less.  If  more
116              properties  are  associated  with the target object they will be
117              put in the PropertiesIterator. If the object had less  than  Max
118              associated properties the Iterator will be a NIL object.
119
120       delete_property(PropertySet, Name) -> Reply
121
122              Types:
123
124                 PropertySet = #objref
125                 Name = string()
126                 Reply  =  ok  |  {'EXCEPTION', #CosPropertyService_FixedProp‐
127                 erty{}}  |   {'EXCEPTION',   #CosPropertyService_PropertyNot‐
128                 Found{}} | {'EXCEPTION', #CosPropertyService_InvalidProperty‐
129                 Name{}}
130
131              This operation tries to delete the property with given Name.  An
132              exception which indicates why it failed is raised if so needed.
133
134       delete_properties(PropertySet, Names) -> Reply
135
136              Types:
137
138                 PropertySet = #objref
139                 Names = [string()]
140                 Reply = ok | {'EXCEPTION', #CosPropertyService_MultipleExcep‐
141                 tions{exceptions = Excs}}
142                 Excs = [#'CosPropertyService_PropertyException{reason =  Rea‐
143                 son, failing_property_name = Name}]
144                 Reason = invalid_property_name | conflicting_property | prop‐
145                 erty_not_found | unsupported_type_code | unsupported_property
146                 | unsupported_mode | fixed_property | read_only_property
147
148              This  operation  tries to delete all given Properties. If one or
149              more removal fails an exception is raised which describe why.
150
151       delete_all_properties(PropertySet) -> boolean()
152
153              Types:
154
155                 PropertySet = #objref
156
157              This operation deletes all properties. The boolean flag, if  set
158              to  false,  indicates  that it was not possible to remove one or
159              more properties, e.g., may be read only.
160
161       is_property_defined(PropertySet, Name) -> Reply
162
163              Types:
164
165                 PropertySet = #objref
166                 Name = non-empty string()
167                 Reply =  boolean()  |  {'EXCEPTION',  #CosPropertyService_In‐
168                 validPropertyName{}}
169
170              This  operation  returns  true  if the target have an associated
171              property with given name.
172
173
174
175Ericsson AB                     cosProperty 5.C1osPropertyService_PropertySet(3)
Impressum