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

CosPropertyService::PropertySet Interface Reference

import "CosPropertyService.idl";

Inherited by CosPropertyService::PropertySetDef.

List of all members.

Public Methods

void define_property (in PropertyName property_name, in any property_value) raises (InvalidPropertyName, ConflictingProperty, UnsupportedTypeCode, UnsupportedProperty, ReadOnlyProperty)
 Will modify or add a property to the PropertySet. More...

void define_properties (in Properties nproperties) raises (MultipleExceptions)
 Will modify or add each of the properties in nproperties. More...

unsigned long get_number_of_properties ()
 Will return the number of properties defined for this PropertySet. More...

void get_all_property_names (in unsigned long how_mstring, out PropertyNames property_names, out PropertyNamesIterator rest)
 Will return a sequence of all property names defined for this PropertySet. More...

any get_property_value (in PropertyName property_name) raises (PropertyNotFound, InvalidPropertyName)
 Will return the value for the property with property_name. More...

boolean get_properties (in PropertyNames property_names, out Properties nproperties)
 Will return the properties for the property names given in the input sequence. More...

void get_all_properties (in unsigned long how_mstring, out Properties nproperties, out PropertiesIterator rest)
 Will return a sequence of all properties defined for this PropertySet. More...

void delete_property (in PropertyName property_name) raises (PropertyNotFound, InvalidPropertyName, FixedProperty)
void delete_properties (in PropertyNames property_names) raises (MultipleExceptions)
 Will delete a number of properties by calling delete_property for each of the names in the input sequence. More...

boolean delete_all_properties ()
 Will delete all properties. More...

boolean is_property_defined (in PropertyName property_name) raises (InvalidPropertyName)
 Will check if a property with property_name is defined for this PropertySet. More...


Member Function Documentation

void CosPropertyService::PropertySet::define_properties in Properties    nproperties raises (MultipleExceptions)
 

Will modify or add each of the properties in nproperties.

The define_property operation will be called for each element in the nproperties sequence.

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

void CosPropertyService::PropertySet::define_property in PropertyName    property_name,
in any    property_value
raises (InvalidPropertyName, ConflictingProperty, UnsupportedTypeCode, UnsupportedProperty, ReadOnlyProperty)
 

Will modify or add a property to the PropertySet.

If the property already exists, then the property type 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.
@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 ReadOnlyProperty - If the property with property_name is already defined and its mode is read_only.

boolean CosPropertyService::PropertySet::delete_all_properties  
 

Will delete all properties.

If any of the properties defined for this PropertySet could not be deleted (i.e. if any property has mode fixed_normal or fixed_readonly), false is returned.

void CosPropertyService::PropertySet::delete_properties in PropertyNames    property_names raises (MultipleExceptions)
 

Will delete a number of properties by calling delete_property for each of the names in the input sequence.

m property_names - A sequence of names for the properties
to be deleted. @raises MultipleExceptions - If any of the calls to delete_property throws an exception.

void CosPropertyService::PropertySet::delete_property in PropertyName    property_name raises (PropertyNotFound, InvalidPropertyName, FixedProperty)
 

void CosPropertyService::PropertySet::get_all_properties in unsigned long    how_mstring,
out Properties    nproperties,
out PropertiesIterator    rest
 

Will return a sequence of all properties defined for this PropertySet.

If more than how_mstring properties are defined, the rest will be return in an iterator.

m how_mstring - The maximum number of properties to return
in the property_names sequence.
m property_names - A sequence of properties. The client is
responsible for deleting out parameters.
m rest - If more properties than how_mstring are defined,
an iterator with the rest of the properties will be returned.

void CosPropertyService::PropertySet::get_all_property_names in unsigned long    how_mstring,
out PropertyNames    property_names,
out PropertyNamesIterator    rest
 

Will return a sequence of all property names defined for this PropertySet.

If more than how_mstring properties are defined, the rest will be return in an iterator.

m how_mstring - The maximum number of names to return in the
property_names sequence.
m property_names - A sequence of property names. The client is
responsible for deleting out parameters.
m rest - If more property names than how_mstring are defined, an
iterator with the rest of the names will be returned.

unsigned long CosPropertyService::PropertySet::get_number_of_properties  
 

Will return the number of properties defined for this PropertySet.

boolean CosPropertyService::PropertySet::get_properties in PropertyNames    property_names,
out Properties    nproperties
 

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

m property_names - A sequence of names for which properties
are to be returned.
m nproperties - A sequence of properties 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.

any CosPropertyService::PropertySet::get_property_value in PropertyName    property_name raises (PropertyNotFound, InvalidPropertyName)
 

Will return the value for the property with property_name.

m property_name - The name of the property to return the
value 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::PropertySet::is_property_defined in PropertyName    property_name raises (InvalidPropertyName)
 

Will check if a property with property_name is defined for this PropertySet.

m property_name - The name of the property to be checked.
@raises InvalidPropertyName - If the property_name is invalid.