User's Guide
Reference Manual
Release Notes
PDF
Top

cosProperty
Reference Manual
Version 1.1.15

Expand All
Contract All

Table of Contents

- cosProperty
  - Top of manual page
  - install/0
  - install_db/0
  - uninstall/0
  - uninstall_db/0
  - start/0
  - start_SetDefFactory/0
  - start_SetFactory/0
  - stop_SetDefFactory/1
  - stop_SetFactory/1
  - stop/0
- CosPropertyService_PropertySetFactory
  - Top of manual page
  - create_propertyset/1
  - create_constrained_propertyset/3
  - create_initial_propertyset/2
- CosPropertyService_PropertySetDefFactory
  - Top of manual page
  - create_propertysetdef/1
  - create_constrained_propertysetdef/3
  - create_initial_propertysetdef/2
- CosPropertyService_PropertySet
  - Top of manual page
  - define_property/3
  - define_properties/2
  - get_number_of_properties/1
  - get_all_property_names/2
  - get_property_value/2
  - get_properties/2
  - get_all_properties/2
  - delete_property/2
  - delete_properties/2
  - delete_all_properties/1
  - is_property_defined/2
- CosPropertyService_PropertySetDef
  - Top of manual page
  - get_allowed_property_types/1
  - get_allowed_properties/1
  - define_property_with_mode/4
  - define_properties_with_modes/2
  - get_property_mode/2
  - get_property_modes/2
  - set_property_mode/3
  - set_property_modes/2
- CosPropertyService_PropertiesIterator
  - Top of manual page
  - reset/1
  - next_one/1
  - next_n/2
  - destroy/1
- CosPropertyService_PropertyNamesIterator
  - Top of manual page
  - reset/1
  - next_one/1
  - next_n/2
  - destroy/1

# CosPropertyService_PropertySetDef

### MODULE

CosPropertyService_PropertySetDef

### MODULE SUMMARY

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_ConflictingProperty{}} | {'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 exception 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_PropertyNotFound{}}
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.