cospropertyservice_propertiesiterator(3erl) [linux man page]
CosPropertyService_PropertiesIterator(3erl) Erlang Module Definition CosPropertyService_PropertiesIterator(3erl)NAME
CosPropertyService_PropertiesIterator - This module implements the OMG CosPropertyService::PropertiesIterator interface.
DESCRIPTION
To get access to the record definitions for the structures use:
-include_lib("cosProperty/include/CosPropertyService.hrl").
EXPORTS
reset(Iterator) -> ok
Types Iterator = #objref
This operation resets the position to the first property.
next_one(Iterator) -> Reply
Types Iterator = #objref
Reply = {boolean(), #'CosPropertyService_Property'{property_name = Name, property_value = Value}}
Name = string()
Value = #any
This operation returns true . If false is returned the out parameter is a non-valid Property.
next_n(Iterator, HowMany) -> Reply
Types Iterator = #objref
HowMany = long()
Reply = {boolean(), Properties}
Properties = [#'CosPropertyService_Property'{property_name = Name, property_value = Value}]
Name = string()
Value = #any
This operation returns true if the requested number of properties can be delivered and there are additional properties. If false is
returned and a sequence of max HowMany properties will be returned and no more properties can be delivered.
destroy(Iterator) -> ok
Types Iterator = #objref
This operation will terminate the Iterator and all subsequent calls will fail.
Ericsson AB cosProperty 1.1.13 CosPropertyService_PropertiesIterator(3erl)
Check Out this Related Man Page
CosPropertyService_PropertySetDef(3erl) Erlang Module Definition CosPropertyService_PropertySetDef(3erl)NAME
CosPropertyService_PropertySetDef - This module implements the OMG CosPropertyService::PropertySetDef interface.
DESCRIPTION
To get access to the record definitions for the structures use:
-include_lib("cosProperty/include/CosPropertyService.hrl").
This module also exports the functions described in
CosPropertyService_PropertySet
EXPORTS
get_allowed_property_types(PropertySetDef) -> Reply
Types PropertySetDef = #objref
Reply = {ok, PropertyTypes}
PropertyTypes = [CORBA::TypeCode]
This operation return the TypeCodes which we are allowed to use when adding new properties.
get_allowed_properties(PropertySetDef) -> Reply
Types PropertySetDef = #objref
Reply = {ok, PropertyDefs}
PropertyDefs = [#'CosPropertyService_PropertyDef'{property_name = Name, property_value = Value, property_mode = Mode}]
Name = string()
Value = #any
Mode = normal | read_only | fixed_normal | fixed_readonly | undefined
This operation a sequence of the allowed properties we may alter; depends on which mode associated with a certain property.
define_property_with_mode(PropertySetDef, Name, Value, Mode) -> Reply
Types PropertySetDef = #objref
Name = non-empty string()
Value = #any
Mode = normal | read_only | fixed_normal | fixed_readonly | undefined
Reply = ok | {'EXCEPTION', #CosPropertyService_InvalidPropertyName{}} | {'EXCEPTION', #CosPropertyService_ConflictingProp-
erty{}} | {'EXCEPTION', #CosPropertyService_UnsupportedTypeCode{}} | {'EXCEPTION', #CosPropertyService_UnsupportedProperty{}}
| {'EXCEPTION', #CosPropertyService_UnsupportedMode{}} | {'EXCEPTION', #CosPropertyService_ReadOnlyProperty{}}
This operation attempts to associate a new property with the target object. If we fail to do so the appropriate exception is raised.
define_properties_with_modes(PropertySetDef, PropertyDefs) -> Reply
Types PropertySetDef = #objref
PropertyDefs = [#'CosPropertyService_PropertyDef'{property_name = Name, property_value = Value, property_mode = Mode}]
Name = string()
Value = #any
Mode = normal | read_only | fixed_normal | fixed_readonly | undefined
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 attempts to associate the given Property Definitions with the target object. If one or more attempts fail an excep-
tion is raised describing which properties we where not able to create.
get_property_mode(PropertySetDef, Name) -> Reply
Types PropertySetDef = #objref
Name = string()
Reply = Mode | {'EXCEPTION', #CosPropertyService_InvalidPropertyName{}} | {'EXCEPTION', #CosPropertyService_PropertyNot-
Found{}}
Mode = normal | read_only | fixed_normal | fixed_readonly | undefined
This operation returns the type of the given property.
get_property_modes(PropertySetDef, Names) -> Reply
Types PropertySetDef = #objref
Names = [string()]
Reply = {boolean(), PropertyModes}
PropertyModes = [#'CosPropertyService_PropertyMode'{property_name = Name, property_mode = Mode}]
Name = string()
Mode = normal | read_only | fixed_normal | fixed_readonly | undefined
This operation returns the modes of the listed properties. If the boolean flag is false, all properties with mode undefined this
operation failed to comply.
set_property_mode(PropertySetDef, Name, Mode) -> Reply
Types PropertySetDef = #objref
Name = string()
Mode = normal | read_only | fixed_normal | fixed_readonly | undefined
Reply = ok | {'EXCEPTION', #CosPropertyService_InvalidPropertyName{}} | {'EXCEPTION', #CosPropertyService_UnsupportedMode{}}
| {'EXCEPTION', #CosPropertyService_PropertyNotFound{}}
This operation changes the given property's mode. Return the appropriate exception if not able to fulfill the request.
set_property_modes(PropertySetDef, PropertyModes) -> Reply
Types PropertySetDef = #objref
PropertyModes = [#'CosPropertyService_PropertyMode'{property_name = Name, property_mode = Mode}]
Name = string()
Mode = normal | read_only | fixed_normal | fixed_readonly | undefined
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 attempts to update the listed properties mode's. Raises an exception which describe which and why an operation
failed.
Ericsson AB cosProperty 1.1.13 CosPropertyService_PropertySetDef(3erl)