1CosPropertyService_PropertySEertlDaenfg(3M)odule DeCfoisnPirtoipoenrtyService_PropertySetDef(3)
2
3
4

NAME

6       CosPropertyService_PropertySetDef  -  This  module  implements  the OMG
7       CosPropertyService::PropertySetDef interface.
8

DESCRIPTION

10       To get access to the record definitions for the structures use:
11       -include_lib("cosProperty/include/CosPropertyService.hrl").
12
13       This module also exports the functions described in
14
15       CosPropertyService_PropertySet
16

EXPORTS

18       get_allowed_property_types(PropertySetDef) -> Reply
19
20              Types:
21
22                 PropertySetDef = #objref
23                 Reply = {ok, PropertyTypes}
24                 PropertyTypes = [CORBA::TypeCode]
25
26              This operation return the TypeCodes which we are allowed to  use
27              when adding new properties.
28
29       get_allowed_properties(PropertySetDef) -> Reply
30
31              Types:
32
33                 PropertySetDef = #objref
34                 Reply = {ok, PropertyDefs}
35                 PropertyDefs    =    [#'CosPropertyService_PropertyDef'{prop‐
36                 erty_name = Name, property_value  =  Value,  property_mode  =
37                 Mode}]
38                 Name = string()
39                 Value = #any
40                 Mode  =  normal | read_only | fixed_normal | fixed_readonly |
41                 undefined
42
43              This operation a sequence  of  the  allowed  properties  we  may
44              alter; depends on which mode associated with a certain property.
45
46       define_property_with_mode(PropertySetDef, Name, Value, Mode) -> Reply
47
48              Types:
49
50                 PropertySetDef = #objref
51                 Name = non-empty string()
52                 Value = #any
53                 Mode  =  normal | read_only | fixed_normal | fixed_readonly |
54                 undefined
55                 Reply = ok | {'EXCEPTION', #CosPropertyService_InvalidProper‐
56                 tyName{}}  |  {'EXCEPTION',  #CosPropertyService_Conflicting‐
57                 Property{}} | {'EXCEPTION',  #CosPropertyService_Unsupported‐
58                 TypeCode{}}  | {'EXCEPTION', #CosPropertyService_Unsupported‐
59                 Property{}} | {'EXCEPTION',  #CosPropertyService_Unsupported‐
60                 Mode{}}   |  {'EXCEPTION',  #CosPropertyService_ReadOnlyProp‐
61                 erty{}}
62
63              This operation attempts to associate a  new  property  with  the
64              target  object. If we fail to do so the appropriate exception is
65              raised.
66
67       define_properties_with_modes(PropertySetDef, PropertyDefs) -> Reply
68
69              Types:
70
71                 PropertySetDef = #objref
72                 PropertyDefs    =    [#'CosPropertyService_PropertyDef'{prop‐
73                 erty_name  =  Name,  property_value  = Value, property_mode =
74                 Mode}]
75                 Name = string()
76                 Value = #any
77                 Mode = normal | read_only | fixed_normal |  fixed_readonly  |
78                 undefined
79                 Reply = ok | {'EXCEPTION', #CosPropertyService_MultipleExcep‐
80                 tions{exceptions = Excs}}
81                 Excs = [#'CosPropertyService_PropertyException{reason =  Rea‐
82                 son, failing_property_name = Name}]
83                 Reason = invalid_property_name | conflicting_property | prop‐
84                 erty_not_found | unsupported_type_code | unsupported_property
85                 | unsupported_mode | fixed_property | read_only_property
86
87              This  operation attempts to associate the given Property Defini‐
88              tions with the target object. If one or more  attempts  fail  an
89              exception  is  raised  describing  which properties we where not
90              able to create.
91
92       get_property_mode(PropertySetDef, Name) -> Reply
93
94              Types:
95
96                 PropertySetDef = #objref
97                 Name = string()
98                 Reply = Mode | {'EXCEPTION', #CosPropertyService_InvalidProp‐
99                 ertyName{}}  | {'EXCEPTION', #CosPropertyService_PropertyNot‐
100                 Found{}}
101                 Mode = normal | read_only | fixed_normal |  fixed_readonly  |
102                 undefined
103
104              This operation returns the type of the given property.
105
106       get_property_modes(PropertySetDef, Names) -> Reply
107
108              Types:
109
110                 PropertySetDef = #objref
111                 Names = [string()]
112                 Reply = {boolean(), PropertyModes}
113                 PropertyModes   =   [#'CosPropertyService_PropertyMode'{prop‐
114                 erty_name = Name, property_mode = Mode}]
115                 Name = string()
116                 Mode = normal | read_only | fixed_normal |  fixed_readonly  |
117                 undefined
118
119              This  operation  returns  the modes of the listed properties. If
120              the boolean flag is false, all properties  with  mode  undefined
121              this operation failed to comply.
122
123       set_property_mode(PropertySetDef, Name, Mode) -> Reply
124
125              Types:
126
127                 PropertySetDef = #objref
128                 Name = string()
129                 Mode  =  normal | read_only | fixed_normal | fixed_readonly |
130                 undefined
131                 Reply = ok | {'EXCEPTION', #CosPropertyService_InvalidProper‐
132                 tyName{}}  |  {'EXCEPTION',  #CosPropertyService_Unsupported‐
133                 Mode{}}  |   {'EXCEPTION',   #CosPropertyService_PropertyNot‐
134                 Found{}}
135
136              This  operation  changes  the  given property's mode. Return the
137              appropriate exception if not able to fulfill the request.
138
139       set_property_modes(PropertySetDef, PropertyModes) -> Reply
140
141              Types:
142
143                 PropertySetDef = #objref
144                 PropertyModes   =   [#'CosPropertyService_PropertyMode'{prop‐
145                 erty_name = Name, property_mode = Mode}]
146                 Name = string()
147                 Mode  =  normal | read_only | fixed_normal | fixed_readonly |
148                 undefined
149                 Reply = ok | {'EXCEPTION', #CosPropertyService_MultipleExcep‐
150                 tions{exceptions = Excs}}
151                 Excs  = [#'CosPropertyService_PropertyException{reason = Rea‐
152                 son, failing_property_name = Name}]
153                 Reason = invalid_property_name | conflicting_property | prop‐
154                 erty_not_found | unsupported_type_code | unsupported_property
155                 | unsupported_mode | fixed_property | read_only_property
156
157              This operation attempts to update the listed properties  mode's.
158              Raises  an  exception  which describe which and why an operation
159              failed.
160
161
162
163Ericsson AB                    cosPropertyC1o.s2P.r3opertyService_PropertySetDef(3)