Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: beans ::

interface XTolerantMultiPropertySet
Description
provides access to multiple iformation of a set of properties with a single call.

The speciality of this interface is that none of the functions will throw the usual exceptions associated with setting and retrieving of property values. Instead the data for the failures is collected and returned.

Note: There is no support for property change listeners in this interface.

See also
XPropertySet, XMultiPropertySet

Methods' Summary
setPropertyValuesTolerant sets the values to the properties with the specified names.  
getPropertyValuesTolerant retrieve the values of the specified properties  
getDirectPropertyValuesTolerant retrieve only those values of the specified properties which are direct values.  
Methods' Details
setPropertyValuesTolerant
sequence< SetPropertyTolerantFailed >
setPropertyValuesTolerant( [in] sequence< string >  aPropertyNames,
[in] sequence< any >  aValues )
raises( ::com::sun::star::lang::IllegalArgumentException );

Description
sets the values to the properties with the specified names.
Parameter aPropertyNames
specifies the names of the properties. The property names must be sorted ascending.

If the names are not sorted the behaviour of the method is undefined!

Parameter aPropertyValues
specifies the values of the properties. The order of the values has to be the same as in the aPropertyNames parameter int order to match the property name with its value.
Returns
An empty sequence if all properties are successfull set. Otherwise for every property value that could not successfully be set an entry of the SetPropertyTolerantFailed will be present in this sequence. The order of the properties is also alphabetically ascending.
Throws
IllegalArgumentException if the number of property names and values do not match.
getPropertyValuesTolerant
sequence< GetPropertyTolerantResult >
getPropertyValuesTolerant( [in] sequence< string >  aPropertyNames );

Description
retrieve the values of the specified properties

The count and order of the values in the returned sequence will be the same as the order of the names in the argument.

Parameter aPropertyNames
specifies the names of the properties. The property names must be sorted ascending.

If the names are not sorted the behaviour of the method is undefined!

Returns
a sequence of type GetPropertyTolerantResult for each of the properties listed in aPropertyNames.
getDirectPropertyValuesTolerant
sequence< GetDirectPropertyTolerantResult >
getDirectPropertyValuesTolerant( [in] sequence< string >  aPropertyNames );

Description
retrieve only those values of the specified properties which are direct values.

Since the count of returned elements may be different from the number of supplied property names the returned elements will also state the name of the property.

Parameter aPropertyNames
specifies the names of the properties. The property names must be sorted ascending.

If the names are not sorted the behaviour of the method is undefined!

Returns
a sequence of type GetDirectPropertyTolerantResult but only for those properties supplied whoms state is DIRECT_VALUE.
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.