2000 2016 Ericsson AB, All Rights Reserved Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. The Initial Developer of the Original Code is Ericsson AB. CosPropertyService_PropertySet 2000-07-25 1.0
CosPropertyService_PropertySet This module implements the OMG CosPropertyService::PropertySet interface.

To get access to the record definitions for the structures use:

-include_lib("cosProperty/include/CosPropertyService.hrl").

 define_property(PropertySet, Name, Value) -> Reply Add a new property to the target object PropertySet = #objref Name = non-empty string() Value = #any Reply = ok | {'EXCEPTION', #CosPropertyService_InvalidPropertyName{}} | {'EXCEPTION', #CosPropertyService_ConflictingProperty{}} | {'EXCEPTION', #CosPropertyService_UnsupportedTypeCode{}} | {'EXCEPTION', #CosPropertyService_UnsupportedProperty{}} | {'EXCEPTION', #CosPropertyService_ReadOnlyProperty{}}

This operation adds a new property to the given object. Depending on which initial arguments was supplied when starting the object several exceptions may be raised.

 define_properties(PropertySet, Properties) -> Reply Add new properties to the target object PropertySet = #objref Properties = [#'CosPropertyService_Property'{property_name = Name, property_value = Value}] Name = string() Value = #any Reply = ok | {'EXCEPTION', #CosPropertyService_MultipleExceptions{exceptions = Excs}} Excs = [#'CosPropertyService_PropertyException{reason = Reason, failing_property_name = Name}] Reason = invalid_property_name | conflicting_property | property_not_found | unsupported_type_code | unsupported_property | unsupported_mode | fixed_property | read_only_property

This operation adds several new properties to the given object. Depending on which initial arguments was supplied when starting the object an exceptions may be raised listing the properties failing.

 get_number_of_properties(PropertySet) -> ulong() Get the number of properties associated with the target object PropertySet = #objref

This operation returns the number of properties associated with the target object.

 get_all_property_names(PropertySet, Max) -> Reply Get Maxproperty names. If the target object have additional associated properties they will be put in the returned Iterator PropertySet = NamesIterator = #objref Max = ulong() Reply = {ok, Names, NamesIterator} Names = [string()]

This operation returns up to Max property names. If the target object have additional associated properties they will be put in the returned Iterator, otherwise the Iterator will be a NIL object.

 get_property_value(PropertySet, Name) -> Reply Return the property value associated with given name PropertySet = #objref Name = string() Reply = #any | {'EXCEPTION', #CosPropertyService_PropertyNotFound{}} | {'EXCEPTION', #CosPropertyService_InvalidPropertyName{}}

This operation returns the property value associated with given name. If no such property exists or the given name is an empty string an exception will be raised.

 get_properties(PropertySet, Names) -> Reply Return all properties associated with given names PropertySet = #objref Names = [string()] Reply = {boolean(), Properties} Properties = [#'CosPropertyService_Property'{property_name = Name, property_value = Value}]

This operation returns all properties associated with given names. If the boolean flag is true all properties where retrieved correctly, otherwise, all properties with the type tk_void was not found.

 get_all_properties(PropertySet, Max) -> Reply Return a list Maxproperties or less. If more properties are associated with the target object they will be put in thePropertiesIterator. PropertySet = PropertiesIterator = #objref Reply = {ok, Properties, PropertiesIterator} Properties = [#'CosPropertyService_Property'{property_name = Name, property_value = Value}]

This operation return a list Max properties or less. If more properties are associated with the target object they will be put in the PropertiesIterator. If the object had less than Max associated properties the Iterator will be a NIL object.

 delete_property(PropertySet, Name) -> Reply Delete the property with given Name PropertySet = #objref Name = string() Reply = ok | {'EXCEPTION', #CosPropertyService_FixedProperty{}} | {'EXCEPTION', #CosPropertyService_PropertyNotFound{}} | {'EXCEPTION', #CosPropertyService_InvalidPropertyName{}}

This operation tries to delete the property with given Name. An exception which indicates why it failed is raised if so needed.

 delete_properties(PropertySet, Names) -> Reply Delete all properties with given Names PropertySet = #objref Names = [string()] Reply = ok | {'EXCEPTION', #CosPropertyService_MultipleExceptions{exceptions = Excs}} Excs = [#'CosPropertyService_PropertyException{reason = Reason, failing_property_name = Name}] Reason = invalid_property_name | conflicting_property | property_not_found | unsupported_type_code | unsupported_property | unsupported_mode | fixed_property | read_only_property

This operation tries to delete all given Properties. If one or more removal fails an exception is raised which describe why.

 delete_all_properties(PropertySet) -> boolean() Delete all properties PropertySet = #objref

This operation deletes all properties. The boolean flag, if set to false, indicates that it was not possible to remove one or more properties, e.g., may be read only.

 is_property_defined(PropertySet, Name) -> Reply Return true if the target have an associated property with given name PropertySet = #objref Name = non-empty string() Reply = boolean() | {'EXCEPTION', #CosPropertyService_InvalidPropertyName{}}

This operation returns true if the target have an associated property with given name.