Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members  

CosPropertyService::PropertySetDef Interface Reference

import "CosPropertyService.idl";

Inherits CosPropertyService::PropertySet.

List of all members.

Public Methods

void get_allowed_property_types (out PropertyTypes property_types)
 Returns the allowed property types for this PropertySetDef. More...

void get_allowed_properties (out PropertyDefs property_defs)
 Returns the allowed properties for this PropertySetDef. More...

void define_property_with_mode (in PropertyName property_name, in any property_value, in PropertyModeType property_mode) raises (InvalidPropertyName, ConflictingProperty, UnsupportedTypeCode, UnsupportedProperty, UnsupportedMode, ReadOnlyProperty)
 Will modify or add a property def to the PropertySetDef. More...

void define_properties_with_modes (in PropertyDefs property_defs) raises (MultipleExceptions)
 Will modify or add each of the properties in property_defs. More...

PropertyModeType get_property_mode (in PropertyName property_name) raises (PropertyNotFound, InvalidPropertyName)
 Returns the mode for the property with property_name. More...

boolean get_property_modes (in PropertyNames property_names, out PropertyModes property_modes)
 Will return the property modes for the property names given in the input sequence. More...

void set_property_mode (in PropertyName property_name, in PropertyModeType property_mode) raises (InvalidPropertyName, PropertyNotFound, UnsupportedMode)
 Sets the mode for the property with property_name. More...

void set_property_modes (in PropertyModes property_modes) raises (MultipleExceptions)
 Set the mode for each of the properties in property_modes. More...


Member Function Documentation

void CosPropertyService::PropertySetDef::define_properties_with_modes in PropertyDefs    property_defs raises (MultipleExceptions)
 

Will modify or add each of the properties in property_defs.

The define_property_with_mode operation will be called for each element in the property_defs sequence.

m nproperties - A sequence of properties.
@raises MultipleExceptions - If any of the calls to define_property_with_mode throws an exception.

void CosPropertyService::PropertySetDef::define_property_with_mode in PropertyName    property_name,
in any    property_value,
in PropertyModeType    property_mode
raises (InvalidPropertyName, ConflictingProperty, UnsupportedTypeCode, UnsupportedProperty, UnsupportedMode, ReadOnlyProperty)
 

Will modify or add a property def to the PropertySetDef.

If the property already exists, then the property type and mode is checked before the value is overwritten.

m property_name - The name of the property to be added
or modified.
m property_value - The new value for the property.
m property_mode - The mode of the property.
@raises InvalidPropertyName - If the property_name is invalid. @raises ConflictingProperty - If a property with property_name is already defined and the type of the property_value conflicts with the current type for the property. @raises UnsupportedTypeCode - If the typecode of the property_value is not supported by this PropertySet. @raises UnsupportedProperty - If the property_name or property_value is not supported by this PropertySet. @raises UnsupportedMode - If the property_mode is not either normal, read_only, fixed_normal or fixed_readonly. @raises ReadOnlyProperty - If the property with property_name is already defined and its mode is read_only.

void CosPropertyService::PropertySetDef::get_allowed_properties out PropertyDefs    property_defs
 

Returns the allowed properties for this PropertySetDef.

The client is responsible for deleting out parameters.

void CosPropertyService::PropertySetDef::get_allowed_property_types out PropertyTypes    property_types
 

Returns the allowed property types for this PropertySetDef.

The client is responsible for deleting out parameters.

PropertyModeType CosPropertyService::PropertySetDef::get_property_mode in PropertyName    property_name raises (PropertyNotFound, InvalidPropertyName)
 

Returns the mode for the property with property_name.

m property_name - The name of the property to return
the mode for. @raises PropertyNotFound - A property with that name was not found. @raises InvalidPropertyName - The specified name was invalid, i.e. the length of the name is zero.

boolean CosPropertyService::PropertySetDef::get_property_modes in PropertyNames    property_names,
out PropertyModes    property_modes
 

Will return the property modes for the property names given in the input sequence.

m property_names - A sequence of names for which property
modes are to be returned.
m property_modes - A sequence of property modes corresponding
to the names in the input sequence. The length of this sequence is at most the length of the input sequence. If one or more properties with a name from the input sequence could not be found (or if any name in the input sequence is invalid), false is returned. The client is responsible for deleting out parameters.

void CosPropertyService::PropertySetDef::set_property_mode in PropertyName    property_name,
in PropertyModeType    property_mode
raises (InvalidPropertyName, PropertyNotFound, UnsupportedMode)
 

Sets the mode for the property with property_name.

Returns false if any of the calls to get_property_mode resulted in an exception.

m property_name - The name of the property to set mode for.
m property_mode - The mode to set.

void CosPropertyService::PropertySetDef::set_property_modes in PropertyModes    property_modes raises (MultipleExceptions)
 

Set the mode for each of the properties in property_modes.

The set_property_mode operation will be called for each element in the property_modes sequence.

m property_modes - A sequence of property modes.
@raises MultipleExceptions - If any of the calls to set_property_mode throws an exception.