aboutsummaryrefslogtreecommitdiffstats
path: root/lib/cosProperty/doc/src/CosPropertyService_PropertySetFactory.xml
diff options
context:
space:
mode:
authorErlang/OTP <[email protected]>2009-11-20 14:54:40 +0000
committerErlang/OTP <[email protected]>2009-11-20 14:54:40 +0000
commit84adefa331c4159d432d22840663c38f155cd4c1 (patch)
treebff9a9c66adda4df2106dfd0e5c053ab182a12bd /lib/cosProperty/doc/src/CosPropertyService_PropertySetFactory.xml
downloadotp-84adefa331c4159d432d22840663c38f155cd4c1.tar.gz
otp-84adefa331c4159d432d22840663c38f155cd4c1.tar.bz2
otp-84adefa331c4159d432d22840663c38f155cd4c1.zip
The R13B03 release.OTP_R13B03
Diffstat (limited to 'lib/cosProperty/doc/src/CosPropertyService_PropertySetFactory.xml')
-rw-r--r--lib/cosProperty/doc/src/CosPropertyService_PropertySetFactory.xml93
1 files changed, 93 insertions, 0 deletions
diff --git a/lib/cosProperty/doc/src/CosPropertyService_PropertySetFactory.xml b/lib/cosProperty/doc/src/CosPropertyService_PropertySetFactory.xml
new file mode 100644
index 0000000000..06b3d2b26d
--- /dev/null
+++ b/lib/cosProperty/doc/src/CosPropertyService_PropertySetFactory.xml
@@ -0,0 +1,93 @@
+<?xml version="1.0" encoding="latin1" ?>
+<!DOCTYPE erlref SYSTEM "erlref.dtd">
+
+<erlref>
+ <header>
+ <copyright>
+ <year>2000</year>
+ <year>2007</year>
+ <holder>Ericsson AB, All Rights Reserved</holder>
+ </copyright>
+ <legalnotice>
+ The contents of this file are subject to the Erlang Public License,
+ Version 1.1, (the "License"); you may not use this file except in
+ compliance with the License. You should have received a copy of the
+ Erlang Public License along with this software. If not, it can be
+ retrieved online at http://www.erlang.org/.
+
+ Software distributed under the License is distributed on an "AS IS"
+ basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
+ the License for the specific language governing rights and limitations
+ under the License.
+
+ The Initial Developer of the Original Code is Ericsson AB.
+ </legalnotice>
+
+ <title>CosPropertyService_&shy;PropertySetFactory</title>
+ <shorttitle>..._PropertySetFactory</shorttitle>
+ <prepared>Niclas Eklund</prepared>
+ <responsible>Niclas Eklund</responsible>
+ <docno></docno>
+ <approved>Niclas Eklund</approved>
+ <checked></checked>
+ <date>2000-07-25</date>
+ <rev>1.0</rev>
+ </header>
+ <module>CosPropertyService_PropertySetFactory</module>
+ <modulesummary>This module implements the OMG CosPropertyService::PropertySetFactory interface.</modulesummary>
+ <description>
+ <p>To get access to the record definitions for the structures use: <br></br>
+<c>-include_lib("cosProperty/include/CosPropertyService.hrl").</c></p>
+ </description>
+ <funcs>
+ <func>
+ <name>create_propertyset(Factory) -> PropertySet</name>
+ <fsummary>Create a new <c>PropertySe</c>t with no predefined properties</fsummary>
+ <type>
+ <v>Factory = PropertySet = #objref</v>
+ </type>
+ <desc>
+ <p>This operation creates a new <c>PropertySe</c>t with no predefined
+ properties.</p>
+ </desc>
+ </func>
+ <func>
+ <name>create_constrained_propertyset(Factory, PropertyTypes, Properties) -> Reply</name>
+ <fsummary>Create a new <c>PropertySet</c>with specified constraints</fsummary>
+ <type>
+ <v>Factory = #objref</v>
+ <v>PropertyTypes = [CORBA::TypeCode]</v>
+ <v>Properties = [#'CosPropertyService_Property'{property_name = Name, property_value = Value}]</v>
+ <v>Name = string()</v>
+ <v>Value = #any</v>
+ <v>Reply = {'EXCEPTION', #CosPropertyService_ConstraintNotSupported{}} | PropertySet</v>
+ <v>PropertySet = #objref</v>
+ </type>
+ <desc>
+ <p>This operation creates a new <c>PropertySet</c> with specific constraints.
+ PropertyTypes states allowed TypeCode's and Properties valid
+ <c>CosPropertyService::Property</c> data.</p>
+ </desc>
+ </func>
+ <func>
+ <name>create_initial_propertyset(Factory, Properties) -> Reply</name>
+ <fsummary>Create a new <c>PropertySet</c>with specified initial properties</fsummary>
+ <type>
+ <v>Factory = #objref</v>
+ <v>Properties = [#'CosPropertyService_Property'{property_name = Name, property_value = Value}]</v>
+ <v>Name = string()</v>
+ <v>Value = #any</v>
+ <v>Reply = {'EXCEPTION', #CosPropertyService_MultipleExceptions{exceptions = Excs}} | PropertySet</v>
+ <v>Excs = [#'CosPropertyService_PropertyException{reason = Reason, failing_property_name = Name}]</v>
+ <v>Reason = invalid_property_name | conflicting_property | property_not_found | unsupported_type_code | unsupported_property | unsupported_mode | fixed_property | read_only_property</v>
+ <v>PropertySet = #objref</v>
+ </type>
+ <desc>
+ <p>This operation creates a new <c>PropertySet</c> with specific
+ initial properties.</p>
+ </desc>
+ </func>
+ </funcs>
+
+</erlref>
+