diff options
Diffstat (limited to 'offapi/com/sun/star/configuration')
96 files changed, 2165 insertions, 2165 deletions
diff --git a/offapi/com/sun/star/configuration/AccessRootElement.idl b/offapi/com/sun/star/configuration/AccessRootElement.idl index e6cab960ecb6..7a2b1b49baba 100644 --- a/offapi/com/sun/star/configuration/AccessRootElement.idl +++ b/offapi/com/sun/star/configuration/AccessRootElement.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -45,19 +45,19 @@ //============================================================================= -module com { module sun { module star { module configuration { +module com { module sun { module star { module configuration { //============================================================================= -/** provides information about the root element of a hierarchy and +/** provides information about the root element of a hierarchy and about the hierarchy as a whole. - + <p>Provides information about the element and the whole hierarchy. Allows controlling the lifetime of the hierarchy. Allows observing changes in the hierarchy as a whole. </p> <p>When access to a hierarchy is first obtained from a factory or provider, - this is the initial object that is created by the factory. + this is the initial object that is created by the factory. It represents the <em>root</em> of the accessible part of the hierarchy. </p> @@ -67,8 +67,8 @@ module com { module sun { module star { module configuration { and that is accessible starting from this element.</em> </p> - <p>Generally it is not possible to navigate the parent or siblings, if any, - of this element, so <type scope="com::sun::star::container">XChild</type> is + <p>Generally it is not possible to navigate the parent or siblings, if any, + of this element, so <type scope="com::sun::star::container">XChild</type> is not supported. </p> @@ -108,7 +108,7 @@ published service AccessRootElement </p> <p>The provider of this object may still dispose of this object, when the - lifetime of the provider ends or if these objects represent + lifetime of the provider ends or if these objects represent the root of only a fragment of an enclosing hierarchy and this fragment is removed from the complete hierarchy by an outside source. </p> @@ -170,7 +170,7 @@ published service AccessRootElement //============================================================================= -}; }; }; }; +}; }; }; }; #endif diff --git a/offapi/com/sun/star/configuration/AdministrationProvider.idl b/offapi/com/sun/star/configuration/AdministrationProvider.idl index 0c4a419fcf1f..5cbc2bcb47ac 100644 --- a/offapi/com/sun/star/configuration/AdministrationProvider.idl +++ b/offapi/com/sun/star/configuration/AdministrationProvider.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -37,51 +37,51 @@ //============================================================================= -module com { module sun { module star { module configuration { +module com { module sun { module star { module configuration { //============================================================================= -/** manages one, or more, complete sets of configuration data for +/** manages one, or more, complete sets of configuration data for administrative puposes and serves as a factory for objects that provide access to subsets of these shared configurations. - - <p>Shared sets of configuration data usually serve to provide defaults, - which are used if no individual settings are present. Depending on the data - store multiple layers of defaults may be combined with a user-specific layer - to make up the final configuration. + + <p>Shared sets of configuration data usually serve to provide defaults, + which are used if no individual settings are present. Depending on the data + store multiple layers of defaults may be combined with a user-specific layer + to make up the final configuration. </p> - <p>Many aspects of the supported behavior depend strongly on the underlying - data store and on the administrative structures it defines. With some data - stores this service also enables access to individual users' configuration - data by an administrator. + <p>Many aspects of the supported behavior depend strongly on the underlying + data store and on the administrative structures it defines. With some data + stores this service also enables access to individual users' configuration + data by an administrator. </p> - <p>On the other hand, in the simplest model there is only a single layer of - default data which is accessible through this service. + <p>On the other hand, in the simplest model there is only a single layer of + default data which is accessible through this service. </p> <p>An implementation is usually obtained from a - <type scope="com::sun::star::lang">ServiceManager</type>. The arguments passed to - <member scope="com::sun::star::lang">XMultiComponentFactory::createInstanceWithContextAndArguments()</member> - select the configuration data source. They may also define the scope of - administrable data or contain credentials to be used to authorize the - administrative access. Missing parameters may be filled in - from the context or the environment. + <type scope="com::sun::star::lang">ServiceManager</type>. The arguments passed to + <member scope="com::sun::star::lang">XMultiComponentFactory::createInstanceWithContextAndArguments()</member> + select the configuration data source. They may also define the scope of + administrable data or contain credentials to be used to authorize the + administrative access. Missing parameters may be filled in + from the context or the environment. </p> @see com::sun::star::configuration::ConfigurationProvider - Offers the same services and creates the same accessor objects as this + Offers the same services and creates the same accessor objects as this service, but accesses the personal configuration. - - <p>A <type> ConfigurationProvider</type> provides access to the personal - layer of configuration data of the current user context. It should in + + <p>A <type> ConfigurationProvider</type> provides access to the personal + layer of configuration data of the current user context. It should in most cases be used when <em>using</em> the configuration data, although - for most contexts a <type>AdministrationProvider</type> can be used as - a drop-in replacement. - </p> + for most contexts a <type>AdministrationProvider</type> can be used as + a drop-in replacement. + </p> */ published service AdministrationProvider { /** allows creating access objects for specific views such as subsets and fragments of the configuration. - + <p>The parameter <var>aServiceSpecifier</var> passed to <member scope="com::sun::star::lang">XMultiServiceFactory::createInstanceWithArguments()</member> supports at least the service specifiers @@ -89,7 +89,7 @@ published service AdministrationProvider <code>"com.sun.star.configuration.ConfigurationUpdateAccess"</code>. </p> - <p>Using the first of these service specifiers requests a read-only view of + <p>Using the first of these service specifiers requests a read-only view of the configuration. The object that is created implements service <type>ConfigurationAccess</type>. To reflect its <em>element role</em> as root of the view, it implements @@ -107,19 +107,19 @@ published service AdministrationProvider <type>ConfigurationAccess</type>/<type>AccessRootElement</type> instead. </p> - <p>The arguments passed to + <p>The arguments passed to <member scope="com::sun::star::lang">XMultiServiceFactory::createInstanceWithArguments()</member> - in parameter <var>aArguments</var> specify the administrative entity for which - data should be administered. In other words they determine the layer to which + in parameter <var>aArguments</var> specify the administrative entity for which + data should be administered. In other words they determine the layer to which changes will apply. They also specify the view of that configuration that should be created. That is, they determine the subset of elements that can be accessed starting from the returned object. Each element of the argument - sequence should be a <type scope="com::sun::star::beans">PropertyValue</type> - or a <type scope="com::sun::star::beans">NamedValue</type>, + sequence should be a <type scope="com::sun::star::beans">PropertyValue</type> + or a <type scope="com::sun::star::beans">NamedValue</type>, so that the parameters can be identified by name rather than by position. </p> - <p>What combinations of arguments are supported depends on the service name + <p>What combinations of arguments are supported depends on the service name and on the data store being administered. </p> @@ -127,30 +127,30 @@ published service AdministrationProvider accept a single argument named <code>nodepath</code> of type <atom>string</atom>. This argument must contain the absolute path to an element of the configuration. The view that is selected consists of the named element and - all its decendants. The administrative entity is the default for the - <type>AdministrationProvider</type>. Usually this is the largest entity - encompassing all entities accessible from this instance. In other words this - can be used to influence as global a scope as possible. - </p> - - <p>Other arguments can be used to select a more specific entity and to control - the behavior of the view. These are different for different implementations - and data stores. Whether and how they are used may also depend on properties + all its decendants. The administrative entity is the default for the + <type>AdministrationProvider</type>. Usually this is the largest entity + encompassing all entities accessible from this instance. In other words this + can be used to influence as global a scope as possible. + </p> + + <p>Other arguments can be used to select a more specific entity and to control + the behavior of the view. These are different for different implementations + and data stores. Whether and how they are used may also depend on properties that were selected when the provider was created. </p> <p>An implementation may ignore unknown arguments.</p> - <p>Some parameters that are commonly supported are described for service + <p>Some parameters that are commonly supported are described for service <type>ConfigurationProvider</type>. </p> - <p>One notable difference exists for parameter <code>"Locale"</code>. For a - <type>ConfigurationProvider</type> the default behavior usually is to select - the locale set up for the user. But this service by default gets data for all - locales for which data is present. Locale-dependent values in this case are - replaced by a <type>SetAccess</type> using the language names as accessors. - This also allows targetted setting of values for selected locales. - This behavior can be requested explicitly by specifing a special argument + <p>One notable difference exists for parameter <code>"Locale"</code>. For a + <type>ConfigurationProvider</type> the default behavior usually is to select + the locale set up for the user. But this service by default gets data for all + locales for which data is present. Locale-dependent values in this case are + replaced by a <type>SetAccess</type> using the language names as accessors. + This also allows targetted setting of values for selected locales. + This behavior can be requested explicitly by specifing a special argument value <code>locale = "*"</code>. </p> @@ -184,7 +184,7 @@ published service AdministrationProvider //============================================================================= -}; }; }; }; +}; }; }; }; #endif diff --git a/offapi/com/sun/star/configuration/CannotLoadConfigurationException.idl b/offapi/com/sun/star/configuration/CannotLoadConfigurationException.idl index 7e6bb2daaaff..21f318569df5 100644 --- a/offapi/com/sun/star/configuration/CannotLoadConfigurationException.idl +++ b/offapi/com/sun/star/configuration/CannotLoadConfigurationException.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -24,28 +24,28 @@ * for a copy of the LGPLv3 License. * ************************************************************************/ -#ifndef __com_sun_star_configuration_CannotLoadConfigurationException_idl__ -#define __com_sun_star_configuration_CannotLoadConfigurationException_idl__ - -#ifndef __com_sun_star_uno_Exception_idl__ -#include <com/sun/star/uno/Exception.idl> -#endif - -//============================================================================= - - module com { module sun { module star { module configuration { - -//============================================================================= - +#ifndef __com_sun_star_configuration_CannotLoadConfigurationException_idl__ +#define __com_sun_star_configuration_CannotLoadConfigurationException_idl__ + +#ifndef __com_sun_star_uno_Exception_idl__ +#include <com/sun/star/uno/Exception.idl> +#endif + +//============================================================================= + + module com { module sun { module star { module configuration { + +//============================================================================= + /** is thrown when an application tries to create a configuration provider but the configuration can't be loaded */ published exception CannotLoadConfigurationException: com::sun::star::uno::Exception -{ -}; - -//============================================================================= - -}; }; }; }; - -#endif +{ +}; + +//============================================================================= + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/configuration/ConfigurationAccess.idl b/offapi/com/sun/star/configuration/ConfigurationAccess.idl index 41662f03f5e2..ae060b92f25c 100644 --- a/offapi/com/sun/star/configuration/ConfigurationAccess.idl +++ b/offapi/com/sun/star/configuration/ConfigurationAccess.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -57,7 +57,7 @@ //============================================================================= -module com { module sun { module star { module configuration { +module com { module sun { module star { module configuration { //============================================================================= /** provides read access to a fragment of the configuration hierarchy. @@ -104,7 +104,7 @@ module com { module sun { module star { module configuration { can thus be classified in the following ways: </p> <ul> - <li><em>Container</em> role: + <li><em>Container</em> role: An object that can hold child elements as a <em>set</em> or a <em>group</em>. </li> <li><em>Element</em> role: @@ -113,7 +113,7 @@ module com { module sun { module star { module configuration { </li> </ul> - <p>Several types of simple <em>values</em> can be used in the configuration. + <p>Several types of simple <em>values</em> can be used in the configuration. In addition to the basic (scalar) types, sequences of the basic types are supported. The basic types are: </p> @@ -159,11 +159,11 @@ module com { module sun { module star { module configuration { </p> <p>If the schema marks a value as <em>nullable</em> (which is indicated by - attribute <const scope="com::sun::star::beans">PropertyAttribute::MAYBEVOID</const> ), + attribute <const scope="com::sun::star::beans">PropertyAttribute::MAYBEVOID</const> ), its contents may be <NULL/>. </p> - <p>The configuration should support explicit access to default values + <p>The configuration should support explicit access to default values (implementing <type scope="com::sun::star::beans">XPropertyState</type> and <type scope="com::sun::star::beans">XPropertyWithState</type>). </p> @@ -201,13 +201,13 @@ published service ConfigurationAccess <p>Implementations shall implement exactly one of:</p> <ul> - <li><type>AccessRootElement</type> if this element is the + <li><type>AccessRootElement</type> if this element is the <em>Root</em> of the whole hierarchy. Objects that can be created directly by a <type>ConfigurationProvider</type> implement this service.</li> - <li><type>SetElement</type> if this element may be contained in a + <li><type>SetElement</type> if this element may be contained in a <em>Set</em>.</li> - <li><type>GroupElement</type> if this element is a child of a + <li><type>GroupElement</type> if this element is a child of a <em>Group</em>.</li> </ul> @@ -242,7 +242,7 @@ published service ConfigurationAccess /** specializes <type>HierarchyElement</type>, if this element may be contained in a <em>Set</em>. - <p>This is an alternative to <type>AccessRootElement</type> + <p>This is an alternative to <type>AccessRootElement</type> or <type>GroupElement</type>. </p> */ @@ -250,7 +250,7 @@ published service ConfigurationAccess /** specializes <type>HierarchyElement</type>, if this element is a child of a <em>Group</em>. - <p>This is an alternative to <type>AccessRootElement</type> + <p>This is an alternative to <type>AccessRootElement</type> or <type>SetElement</type>. </p> */ @@ -259,7 +259,7 @@ published service ConfigurationAccess //============================================================================= -}; }; }; }; +}; }; }; }; #endif diff --git a/offapi/com/sun/star/configuration/ConfigurationProvider.idl b/offapi/com/sun/star/configuration/ConfigurationProvider.idl index c6924acf6c6e..b1b5e797d93b 100644 --- a/offapi/com/sun/star/configuration/ConfigurationProvider.idl +++ b/offapi/com/sun/star/configuration/ConfigurationProvider.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -37,28 +37,28 @@ //============================================================================= -module com { module sun { module star { module configuration { +module com { module sun { module star { module configuration { //============================================================================= /** manages one, or more, complete sets of configuration data and serves as a factory for objects that provide access to a subset of the configuration. - + <p>An implementation is usually obtained from a - <type scope="com::sun::star::lang">ServiceManager</type>. The arguments passed to - <member scope="com::sun::star::lang">XMultiComponentFactory::createInstanceWithContextAndArguments()</member> + <type scope="com::sun::star::lang">ServiceManager</type>. The arguments passed to + <member scope="com::sun::star::lang">XMultiComponentFactory::createInstanceWithContextAndArguments()</member> select the configuration data source. Arguments must be provided as - <type scope="com::sun::star::beans">NamedValue</type> - or <type scope="com::sun::star::beans">PropertyValue</type>. - If the parameters given are incomplete missing values are taken - from the context or the environment. If an instance already exists for the - given set of arguments, the existing instance may be reused. - In particular, instantiating a provider without explicit arguments to access - the default configuration data will always yield the same + <type scope="com::sun::star::beans">NamedValue</type> + or <type scope="com::sun::star::beans">PropertyValue</type>. + If the parameters given are incomplete missing values are taken + from the context or the environment. If an instance already exists for the + given set of arguments, the existing instance may be reused. + In particular, instantiating a provider without explicit arguments to access + the default configuration data will always yield the same <type scope="com::sun::star::configuration">DefaultProvider</type> object. </p> - <p>Some arguments for - <member scope="com::sun::star::lang">XMultiServiceFactory::createInstanceWithArguments()</member> - may be given default values during creation of this service. In particular + <p>Some arguments for + <member scope="com::sun::star::lang">XMultiServiceFactory::createInstanceWithArguments()</member> + may be given default values during creation of this service. In particular this applies to the parameters <code>"Locale"</code> and <code>"EnableAsync"</code>. </p> */ @@ -66,7 +66,7 @@ published service ConfigurationProvider { /** allows creating access objects for specific views such as subsets and fragments of the configuration. - + <p>The parameter <var>aServiceSpecifier</var> passed to <member scope="com::sun::star::lang">XMultiServiceFactory::createInstanceWithArguments()</member> supports at least the service specifiers @@ -74,7 +74,7 @@ published service ConfigurationProvider <code>"com.sun.star.configuration.ConfigurationUpdateAccess"</code>. </p> - <p>Using the first of these service specifiers requests a read-only view of + <p>Using the first of these service specifiers requests a read-only view of the configuration. The object that is created implements service <type>ConfigurationAccess</type>. To reflect its <em>element role</em> as root of the view, it implements @@ -92,13 +92,13 @@ published service ConfigurationProvider <type>ConfigurationAccess</type>/<type>AccessRootElement</type> instead. </p> - <p>The arguments passed to + <p>The arguments passed to <member scope="com::sun::star::lang">XMultiServiceFactory::createInstanceWithArguments()</member> in parameter <var>aArguments</var> specify the view of the configuration that should be created. That is, they determine the subset of elements that can be accessed starting from the returned object. Each element of the argument - sequence should be a <type scope="com::sun::star::beans">PropertyValue</type> - or a <type scope="com::sun::star::beans">NamedValue</type>, + sequence should be a <type scope="com::sun::star::beans">PropertyValue</type> + or a <type scope="com::sun::star::beans">NamedValue</type>, so that the parameters can be identified by name rather than by position. </p> @@ -111,7 +111,7 @@ published service ConfigurationProvider configuration. The view that is selected consists of the named element and all its decendants. </p> - + <p>Other arguments can be used to control the behavior of the view. These are different for different implementations. Whether and how they are used may also depend on the configuration store and configuration that were @@ -134,7 +134,7 @@ published service ConfigurationProvider view. </dd> <dt><code>"locale"</code> : <type scope="com::sun::star::lang">Locale</type></dt> - <dd>specifies the locale for which localized values should be + <dd>specifies the locale for which localized values should be retrieved. </dd> </dl> @@ -145,10 +145,10 @@ published service ConfigurationProvider | - B2 - C2 (localized: de, en, fr, ..) | | - | - C3 - D1 + | - C3 - D1 | | | | | - D2 - E1 - | | + | | | - C4 - D3 - E2 - F1 | | | | | - F2 @@ -157,7 +157,7 @@ published service ConfigurationProvider | - B3 | - - B4 - C6 - D4 - E3 + - B4 - C6 - D4 - E3 </pre> <BR />selecting a view with <code>nodepath = "/A/B2"</code>, @@ -169,8 +169,8 @@ published service ConfigurationProvider - C3 - D1 | | | - D2 (..) - | - - C4 - D3 (..) + | + - C4 - D3 (..) | - C5 @@ -191,19 +191,19 @@ published service ConfigurationProvider storage at once - that is before <member scope="com::sun::star::util">XChangesBatch::commitChanges()</member> returns. - <p><em>This parameter was formerly called <code>"lazywrite"</code>. + <p><em>This parameter was formerly called <code>"lazywrite"</code>. The old name should still be supported for compatibility. </em></p> </dd> <dt><code>"nocache"</code> : <atom>boolean</atom></dt> - <dd>This deprecated parameter + <dd>This deprecated parameter specifies that data for the view is not taken from the cache, but read directly from storage. This may entail that future changes that become visible in the cache are not reflected in this view and that changes done through this view are not reflected in the cache. <BR /><strong>Use with caution !</strong> - <p><em>This parameter is not supported by all implementations and may be + <p><em>This parameter is not supported by all implementations and may be silently ignored ! </em></p> </dd> @@ -226,7 +226,7 @@ published service ConfigurationProvider <p>The owner of the provider may dispose of this object using <member scope="com::sun::star::lang">XComponent::dispose()</member>. - Note that the default provider is owned by the + Note that the default provider is owned by the <type scope="com::sun::star::lang">ServiceManager</type> and should not be disposed of by user code. </p> @@ -244,7 +244,7 @@ published service ConfigurationProvider //============================================================================= -}; }; }; }; +}; }; }; }; #endif diff --git a/offapi/com/sun/star/configuration/ConfigurationRegistry.idl b/offapi/com/sun/star/configuration/ConfigurationRegistry.idl index 870af90e7986..63deac49c749 100644 --- a/offapi/com/sun/star/configuration/ConfigurationRegistry.idl +++ b/offapi/com/sun/star/configuration/ConfigurationRegistry.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -36,25 +36,25 @@ #include <com/sun/star/util/XFlushable.idl> #endif -module com { module sun { module star { module configuration { +module com { module sun { module star { module configuration { //============================================================================= -/* provides access to a configuration tree as a registry. +/* provides access to a configuration tree as a registry. <p>This service is deprecated, <type scope="com.sun.star.configuration">ConfigurationProvider</type> should be used instead.</p> - <p> Using the <type scope="com::sun::star::registry">XSimpleRegistry</type> - interface, the service can be bound to a subtree within the - configuration tree, as provided by an + <p> Using the <type scope="com::sun::star::registry">XSimpleRegistry</type> + interface, the service can be bound to a subtree within the + configuration tree, as provided by an <type scope="com.sun.star.configuration">ConfigurationProvider</type> service, which must be accessible from the service factory you use for the creation of this service. </p> - <p> There are some restrictions when accessing a configuration tree using a registry. + <p> There are some restrictions when accessing a configuration tree using a registry. Most of them are implications of the fact that a configuration tree is very static in it's structure. Removal and addition of sub nodes is allowed only for special nodes, and even then the new elements have to comply to a given scheme (which is some @@ -67,14 +67,14 @@ module com { module sun { module star { module configuration { and all of it's aspects. </p> - @author Frank Schoenheit + @author Frank Schoenheit @version 1.0 2000/07/06 */ published service ConfigurationRegistry { /** controls the binding of the object to a configuration sub tree. - <p><member scope="com::sun::star::registry">XSimpleRegistry::open()</member> + <p><member scope="com::sun::star::registry">XSimpleRegistry::open()</member> is used to open a special subtree within the configuration tree. </p> <p>The parameters of this method control the location of the root of the to-be-opened @@ -84,14 +84,14 @@ published service ConfigurationRegistry interface com::sun::star::registry::XSimpleRegistry; /** is used to commit changes to the configuration. - <p>As specified for the + <p>As specified for the <type scope="com::sun::star::configuration">ConfigurationUpdateAccess</type> - service, all changes made to an configuration subtree have to be commited - before they become persistent. + service, all changes made to an configuration subtree have to be commited + before they become persistent. To do this for a configuration accessed as a registry, call <method scope="com::sun::star::util">XFlushable::flush</method>. </p> - <p><strong>Warning:</strong><em>Changes that are not flushed will be + <p><strong>Warning:</strong><em>Changes that are not flushed will be lost.</em> </p> */ @@ -101,7 +101,7 @@ published service ConfigurationRegistry //============================================================================= -}; }; }; }; +}; }; }; }; #endif diff --git a/offapi/com/sun/star/configuration/ConfigurationUpdateAccess.idl b/offapi/com/sun/star/configuration/ConfigurationUpdateAccess.idl index bd13b167c2c5..cbba3ed10749 100644 --- a/offapi/com/sun/star/configuration/ConfigurationUpdateAccess.idl +++ b/offapi/com/sun/star/configuration/ConfigurationUpdateAccess.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -45,7 +45,7 @@ //============================================================================= -module com { module sun { module star { module configuration { +module com { module sun { module star { module configuration { //============================================================================= /** provides modifying access to a fragment of the configuration hierarchy. @@ -55,7 +55,7 @@ module com { module sun { module star { module configuration { </p> <p>Descendants of this service also implement this service - unless they are marked <em>read-only</em> (which is indicated by attribute + unless they are marked <em>read-only</em> (which is indicated by attribute <const scope="com::sun::star::beans">PropertyAttribute::READONLY</const>), in which case they only need implement <type>ConfigurationAccess</type>. </p> @@ -68,7 +68,7 @@ module com { module sun { module star { module configuration { extensions of the respective services documented for <type>ConfigurationAccess</type>. </p> <ul> - <li><em>Container</em> role: + <li><em>Container</em> role: A <em>group</em> permits changing child values. A <em>set</em> permits inserting and removing contained elements. </li> @@ -114,7 +114,7 @@ published service ConfigurationUpdateAccess [optional] service SetUpdate; /** specializes <type>GroupAccess</type> to support modifying contained - data. + data. <p>Implemented, if this element is a <em>Group</em>. Otherwise service <type>SetUpdate</type> is provided. @@ -138,7 +138,7 @@ published service ConfigurationUpdateAccess //============================================================================= -}; }; }; }; +}; }; }; }; #endif diff --git a/offapi/com/sun/star/configuration/CorruptedConfigurationException.idl b/offapi/com/sun/star/configuration/CorruptedConfigurationException.idl index a2e827003eb3..fd8ec35e373f 100644 --- a/offapi/com/sun/star/configuration/CorruptedConfigurationException.idl +++ b/offapi/com/sun/star/configuration/CorruptedConfigurationException.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -24,20 +24,20 @@ * for a copy of the LGPLv3 License. * ************************************************************************/ -#ifndef __com_sun_star_configuration_CorruptedConfigurationException_idl__ -#define __com_sun_star_configuration_CorruptedConfigurationException_idl__ - -#ifndef __com_sun_star_uno_RuntimeException_idl__ -#include <com/sun/star/uno/RuntimeException.idl> -#endif - - -//============================================================================= - -module com { module sun { module star { module configuration { - -//============================================================================= - +#ifndef __com_sun_star_configuration_CorruptedConfigurationException_idl__ +#define __com_sun_star_configuration_CorruptedConfigurationException_idl__ + +#ifndef __com_sun_star_uno_RuntimeException_idl__ +#include <com/sun/star/uno/RuntimeException.idl> +#endif + + +//============================================================================= + +module com { module sun { module star { module configuration { + +//============================================================================= + /** This exception is thrown in case a configuration does not exists or contains corrupt data. @@ -52,10 +52,10 @@ published exception CorruptedConfigurationException : ::com::sun::star::uno::Run /** Instead of the message part of an exception, this value describe the type of corruption more in detail. */ string Details; -}; - -//============================================================================= - -}; }; }; }; - -#endif +}; + +//============================================================================= + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/configuration/CorruptedUIConfigurationException.idl b/offapi/com/sun/star/configuration/CorruptedUIConfigurationException.idl index 5373cb570a91..14bd759ae314 100644 --- a/offapi/com/sun/star/configuration/CorruptedUIConfigurationException.idl +++ b/offapi/com/sun/star/configuration/CorruptedUIConfigurationException.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -24,20 +24,20 @@ * for a copy of the LGPLv3 License. * ************************************************************************/ -#ifndef __com_sun_star_configuration_CorruptedUIConfigurationException_idl__ -#define __com_sun_star_configuration_CorruptedUIConfigurationException_idl__ - -#ifndef __com_sun_star_configuration_CorruptedConfigurationException_idl__ -#include <com/sun/star/configuration/CorruptedConfigurationException.idl> -#endif - - -//============================================================================= - -module com { module sun { module star { module configuration { - -//============================================================================= - +#ifndef __com_sun_star_configuration_CorruptedUIConfigurationException_idl__ +#define __com_sun_star_configuration_CorruptedUIConfigurationException_idl__ + +#ifndef __com_sun_star_configuration_CorruptedConfigurationException_idl__ +#include <com/sun/star/configuration/CorruptedConfigurationException.idl> +#endif + + +//============================================================================= + +module com { module sun { module star { module configuration { + +//============================================================================= + /** This exception is thrown in case the global UI configuration (including menubars/toolbars and accelerators) does not exists or contains corrupted data. @@ -46,10 +46,10 @@ module com { module sun { module star { module configuration { */ published exception CorruptedUIConfigurationException : ::com::sun::star::configuration::CorruptedConfigurationException { -}; - -//============================================================================= - -}; }; }; }; - -#endif +}; + +//============================================================================= + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/configuration/DefaultProvider.idl b/offapi/com/sun/star/configuration/DefaultProvider.idl index b41bdeec33a5..337516f737ac 100644 --- a/offapi/com/sun/star/configuration/DefaultProvider.idl +++ b/offapi/com/sun/star/configuration/DefaultProvider.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -29,13 +29,13 @@ #ifndef __com_sun_star_configuration_ConfigurationProvider_idl__ #include <com/sun/star/configuration/ConfigurationProvider.idl> -#endif +#endif -#ifndef __com_sun_star_util_XRefreshable_idl__ +#ifndef __com_sun_star_util_XRefreshable_idl__ #include <com/sun/star/util/XRefreshable.idl> #endif -#ifndef __com_sun_star_util_XFlushable_idl__ +#ifndef __com_sun_star_util_XFlushable_idl__ #include <com/sun/star/util/XFlushable.idl> #endif @@ -44,26 +44,26 @@ #endif -//============================================================================= +//============================================================================= -module com { module sun { module star { module configuration { +module com { module sun { module star { module configuration { -//============================================================================= +//============================================================================= /** - is a <type>ConfigurationProvider</type>, that is + is a <type>ConfigurationProvider</type>, that is the default <type>ConfigurationProvider</type> for its <type scope="com::sun::star::uno">XComponentContext</type>. - + <p>This object is accessible as singleton within the context</p>. @since OOo 1.1.2 */ -published service DefaultProvider +published service DefaultProvider { - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- - /** characterizes the functionality. + /** characterizes the functionality. */ service ConfigurationProvider ; @@ -77,24 +77,24 @@ published service DefaultProvider [optional] interface com::sun::star::util::XFlushable; /** Enable setting/getting locale for Provider - + @since OOo 2.0.0 */ [optional] interface com::sun::star::lang::XLocalizable; /** Property to enable/disable asynchronous write-back from in-memory cache to backend(s) - + @since OOo 2.0.0 */ [optional,property] boolean EnableAsync; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- } ; -//============================================================================= +//============================================================================= -} ; } ; } ; } ; +} ; } ; } ; } ; -#endif +#endif diff --git a/offapi/com/sun/star/configuration/GroupAccess.idl b/offapi/com/sun/star/configuration/GroupAccess.idl index 46c0312eb617..7b2672d86c52 100644 --- a/offapi/com/sun/star/configuration/GroupAccess.idl +++ b/offapi/com/sun/star/configuration/GroupAccess.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -45,12 +45,12 @@ //============================================================================= -module com { module sun { module star { module configuration { +module com { module sun { module star { module configuration { //============================================================================= /** provides access to a predefined heterogeneous group of values and nested trees as part of a hierarchy. - + <p>Provides access to, and information about, its children and descendants viewed either as properties or as contained elements. </p> @@ -90,7 +90,7 @@ published service GroupAccess </p> <p>If such elements occur as properties or subproperties of an implementation, - it is not specified whether direct subproperty access using + it is not specified whether direct subproperty access using <type scope="com::sun::star::beans">XHierarchicalPropertySet</type> or <type scope="com::sun::star::beans">XMultiHierarchicalPropertySet</type> can be used to access descendants of such elements. @@ -110,25 +110,25 @@ published service GroupAccess service PropertyHierarchy; /** provides access to the state of child elements of an implementation. [optional] - - <p>This interface should be present, if the hierarchy supports default values + + <p>This interface should be present, if the hierarchy supports default values for simple (non-object) properties and the group contains such properties. </p> - <p>For properties that are objects themselves, the semantic documented for + <p>For properties that are objects themselves, the semantic documented for service <type>HierarchyAccess</type> applies. </p> */ [optional] interface com::sun::star::beans::XPropertyState; -/** provides access to the states of multiple child elements of +/** provides access to the states of multiple child elements of an implementation. [optional] - <p>This interface should be present, if the hierarchy supports default values + <p>This interface should be present, if the hierarchy supports default values for simple (non-object) properties and the group contains such properties. </p> - <p>For properties that are objects themselves, the semantic documented for + <p>For properties that are objects themselves, the semantic documented for service <type>HierarchyAccess</type> applies. </p> */ @@ -137,7 +137,7 @@ published service GroupAccess //============================================================================= -}; }; }; }; +}; }; }; }; #endif diff --git a/offapi/com/sun/star/configuration/GroupElement.idl b/offapi/com/sun/star/configuration/GroupElement.idl index 0f66580b0c92..15068860f51f 100644 --- a/offapi/com/sun/star/configuration/GroupElement.idl +++ b/offapi/com/sun/star/configuration/GroupElement.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -37,7 +37,7 @@ //============================================================================= -module com { module sun { module star { module configuration { +module com { module sun { module star { module configuration { //============================================================================= /** provides information about a predefined element contained in a @@ -83,7 +83,7 @@ published service GroupElement //============================================================================= -}; }; }; }; +}; }; }; }; #endif diff --git a/offapi/com/sun/star/configuration/GroupUpdate.idl b/offapi/com/sun/star/configuration/GroupUpdate.idl index 0c7184c003c7..c834f09aee7b 100644 --- a/offapi/com/sun/star/configuration/GroupUpdate.idl +++ b/offapi/com/sun/star/configuration/GroupUpdate.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -37,7 +37,7 @@ //============================================================================= -module com { module sun { module star { module configuration { +module com { module sun { module star { module configuration { //============================================================================= /** provides write access to a predefined heterogeneous group of values @@ -49,7 +49,7 @@ module com { module sun { module star { module configuration { */ published service GroupUpdate { -/** is the basic service providing read access to a group element of the +/** is the basic service providing read access to a group element of the hierarchy. <p>Any child and descendant objects support modifying access as well, @@ -61,7 +61,7 @@ published service GroupUpdate /** allows replacing values. - <p>This service extends the interface + <p>This service extends the interface <type scope="com::sun::star::container">XNameAccess</type> supported by service <type>GroupAccess</type> to allow changing values. This strongly overlaps with functionality available through @@ -87,7 +87,7 @@ published service GroupUpdate //============================================================================= -}; }; }; }; +}; }; }; }; #endif diff --git a/offapi/com/sun/star/configuration/HierarchyAccess.idl b/offapi/com/sun/star/configuration/HierarchyAccess.idl index a5779042cd42..675c2ad547a2 100644 --- a/offapi/com/sun/star/configuration/HierarchyAccess.idl +++ b/offapi/com/sun/star/configuration/HierarchyAccess.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -57,13 +57,13 @@ //============================================================================= -module com { module sun { module star { module configuration { +module com { module sun { module star { module configuration { //============================================================================= /** provides access to a hierarchy of descendant elements. - <p>Subnodes are accessed by their name. Values that are direct or indirect - descendants of this tree node can be retrieved. Non-value subnodes can be + <p>Subnodes are accessed by their name. Values that are direct or indirect + descendants of this tree node can be retrieved. Non-value subnodes can be navigated using container interfaces. Other interfaces provide access to information about this node. Changes to values in the subtree can be monitored by event listeners. @@ -90,7 +90,7 @@ published service HierarchyAccess */ interface com::sun::star::container::XNameAccess; -/** allows access to all descendants of this node +/** allows access to all descendants of this node <p><member scope="com::sun::star::container">XHierarchicalNameAccess::getByHierarchicalName()</member> returns an <atom>any</atom> holding either a simple value or an interface @@ -108,10 +108,10 @@ published service HierarchyAccess <type scope="com::sun::star::container">XNameAccess</type>, <type scope="com::sun::star::container">XHierarchicalNameAccess</type>, <type scope="com::sun::star::beans">XPropertySet</type> or - any other interfaces that allow access to or manipulation of subnodes - selected by name or hierarchical name. + any other interfaces that allow access to or manipulation of subnodes + selected by name or hierarchical name. </p> - <p>If an inexact name could be matched to either a simple or a hierachical + <p>If an inexact name could be matched to either a simple or a hierachical name, the simple (immediate child) name is preferred. </p> */ @@ -121,13 +121,13 @@ published service HierarchyAccess <p>This interface may be missing, if the hierarchy supports no traits that are described by <type scope="com::sun::star::beans">PropertyAttribute</type> - values or if the same information is available by other means, - e.g. if the implementation supports + values or if the same information is available by other means, + e.g. if the implementation supports <member scope="com::sun::star::beans">XPropertySet::getPropertySetInfo()</member>. </p> - <p>If a child of this node is an object that implements - <type scope="com::sun::star::beans">XProperty</type>, then this implementation + <p>If a child of this node is an object that implements + <type scope="com::sun::star::beans">XProperty</type>, then this implementation returns the same <type scope="com::sun::star::beans">Property</type> for that child as the child itself. </p> @@ -135,19 +135,19 @@ published service HierarchyAccess [optional] interface com::sun::star::beans::XPropertySetInfo; /** provides access to the state of child elements of an implementation. [optional] - + <p>This interface may be missing if the hierarchy (or a hierarchy fragment that contains this implementation as element) does not support default values or if the node does not support accessing the default state of individual children. </p> - + <p>If elements that are not simple values, but objects themselves, support - a default state (as indicated by + a default state (as indicated by <const scope="com::sun::star::beans">PropertyAttribute::MAYBEDEFAULT</const>), - they should implement + they should implement <type scope="com::sun::star::beans">XPropertyWithState</type>, in which case the <type scope="com::sun::star::beans">PropertyState</type> applies to all - their children and recursively to all descendants. + their children and recursively to all descendants. </p> <p>If an implementation is part of a <em>read-only</em> view of the hierarchy, @@ -156,21 +156,21 @@ published service HierarchyAccess */ [optional] interface com::sun::star::beans::XPropertyState; -/** provides access to the states of multiple child elements of +/** provides access to the states of multiple child elements of an implementation. [optional] - + <p>This interface may be missing if the hierarchy (or a hierarchy fragment - that contains this implementation as element) does not support default values + that contains this implementation as element) does not support default values if the node does not support accessing the default state of individual children. </p> - + <p>If elements that are not simple values, but objects themselves, support - a default state (as indicated by + a default state (as indicated by <const scope="com::sun::star::beans">PropertyAttribute::MAYBEDEFAULT</const>), - they should implement + they should implement <type scope="com::sun::star::beans">XPropertyWithState</type>, in which case the <type scope="com::sun::star::beans">PropertyState</type> applies to all - their children and recursively to all descendants. + their children and recursively to all descendants. </p> <p>If an implementation is part of a <em>read-only</em> view of the hierarchy, @@ -182,6 +182,6 @@ published service HierarchyAccess //============================================================================= -}; }; }; }; +}; }; }; }; #endif diff --git a/offapi/com/sun/star/configuration/HierarchyElement.idl b/offapi/com/sun/star/configuration/HierarchyElement.idl index 7a784821e202..580a48663732 100644 --- a/offapi/com/sun/star/configuration/HierarchyElement.idl +++ b/offapi/com/sun/star/configuration/HierarchyElement.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -49,7 +49,7 @@ //============================================================================= -module com { module sun { module star { module configuration { +module com { module sun { module star { module configuration { //============================================================================= /** provides information about an element within a hierarchy. @@ -58,7 +58,7 @@ module com { module sun { module star { module configuration { Attributes detailing the role of the element can be queried. The state of the element (regarding defaults) can be accessed. </p> - + <p>Implementations of this service usually also implement service <type>HierarchyAccess</type>, which concerns the complementary role of providing access to subelements of the hierarchy. @@ -71,7 +71,7 @@ published service HierarchyElement */ interface com::sun::star::container::XHierarchicalName; -/** provides the local name of this element within its parent. +/** provides the local name of this element within its parent. <p><em>Renaming an element is generally not supported.</em></p> */ @@ -84,7 +84,7 @@ published service HierarchyElement values. </p> - <p>If the parent of this object implements + <p>If the parent of this object implements <type scope="com::sun::star::beans">XPropertySetInfo</type>, then this returns the same <type scope="com::sun::star::beans">Property</type> as the <type scope="com::sun::star::beans">XPropertySetInfo</type> of the parent. @@ -98,7 +98,7 @@ published service HierarchyElement a default state and values only for simple values or not at all. </p> - <p>If the parent of this object implements + <p>If the parent of this object implements <type scope="com::sun::star::beans">XPropertyState</type>, then members of this interface have the same effect as corresponding members of the parent. </p> @@ -109,9 +109,9 @@ published service HierarchyElement */ [optional] interface com::sun::star::beans::XPropertyWithState; -/** provides access to the parent of this element [optional]. +/** provides access to the parent of this element [optional]. - <p>This interface may be missing if this object is not obtained + <p>This interface may be missing if this object is not obtained as a child or descendant of another tree node, for example, directly from a factory or provider. </p> @@ -127,6 +127,6 @@ published service HierarchyElement //============================================================================= -}; }; }; }; +}; }; }; }; #endif diff --git a/offapi/com/sun/star/configuration/InstallationIncompleteException.idl b/offapi/com/sun/star/configuration/InstallationIncompleteException.idl index 568c36674286..3d4e712fa1f6 100644 --- a/offapi/com/sun/star/configuration/InstallationIncompleteException.idl +++ b/offapi/com/sun/star/configuration/InstallationIncompleteException.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -24,28 +24,28 @@ * for a copy of the LGPLv3 License. * ************************************************************************/ -#ifndef __com_sun_star_configuration_InstallationIncompleteException_idl__ -#define __com_sun_star_configuration_InstallationIncompleteException_idl__ - -#ifndef __com_sun_star_configuration_CannotLoadConfigurationException_idl__ -#include <com/sun/star/configuration/CannotLoadConfigurationException.idl> -#endif - -//============================================================================= - - module com { module sun { module star { module configuration { - -//============================================================================= - +#ifndef __com_sun_star_configuration_InstallationIncompleteException_idl__ +#define __com_sun_star_configuration_InstallationIncompleteException_idl__ + +#ifndef __com_sun_star_configuration_CannotLoadConfigurationException_idl__ +#include <com/sun/star/configuration/CannotLoadConfigurationException.idl> +#endif + +//============================================================================= + + module com { module sun { module star { module configuration { + +//============================================================================= + /** is thrown when creating a configuration provider fails because the user's installation for the is missing or incomplete */ published exception InstallationIncompleteException: com::sun::star::configuration::CannotLoadConfigurationException -{ -}; - -//============================================================================= - -}; }; }; }; - -#endif +{ +}; + +//============================================================================= + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/configuration/InvalidBootstrapFileException.idl b/offapi/com/sun/star/configuration/InvalidBootstrapFileException.idl index d7cba09edf41..5fd59439058d 100644 --- a/offapi/com/sun/star/configuration/InvalidBootstrapFileException.idl +++ b/offapi/com/sun/star/configuration/InvalidBootstrapFileException.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -24,30 +24,30 @@ * for a copy of the LGPLv3 License. * ************************************************************************/ -#ifndef __com_sun_star_configuration_InvalidBootstrapFileException_idl__ -#define __com_sun_star_configuration_InvalidBootstrapFileException_idl__ - -#ifndef __com_sun_star_configuration_CannotLoadConfigurationException_idl__ -#include <com/sun/star/configuration/CannotLoadConfigurationException.idl> -#endif - -//============================================================================= - - module com { module sun { module star { module configuration { - -//============================================================================= - +#ifndef __com_sun_star_configuration_InvalidBootstrapFileException_idl__ +#define __com_sun_star_configuration_InvalidBootstrapFileException_idl__ + +#ifndef __com_sun_star_configuration_CannotLoadConfigurationException_idl__ +#include <com/sun/star/configuration/CannotLoadConfigurationException.idl> +#endif + +//============================================================================= + + module com { module sun { module star { module configuration { + +//============================================================================= + /** is thrown when creating a configuration provider fails because a bootstrap file needed to locate the configuration contains invalid data */ published exception InvalidBootstrapFileException: com::sun::star::configuration::CannotLoadConfigurationException -{ +{ /// the URL of the bootstrap file that is invalid string BootstrapFileURL; -}; - -//============================================================================= - -}; }; }; }; - -#endif +}; + +//============================================================================= + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/configuration/MissingBootstrapFileException.idl b/offapi/com/sun/star/configuration/MissingBootstrapFileException.idl index b9588dc09a83..5c70af4cfd87 100644 --- a/offapi/com/sun/star/configuration/MissingBootstrapFileException.idl +++ b/offapi/com/sun/star/configuration/MissingBootstrapFileException.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -24,30 +24,30 @@ * for a copy of the LGPLv3 License. * ************************************************************************/ -#ifndef __com_sun_star_configuration_MissingBootstrapFileException_idl__ -#define __com_sun_star_configuration_MissingBootstrapFileException_idl__ - -#ifndef __com_sun_star_configuration_CannotLoadConfigurationException_idl__ -#include <com/sun/star/configuration/CannotLoadConfigurationException.idl> -#endif - -//============================================================================= - - module com { module sun { module star { module configuration { - -//============================================================================= - +#ifndef __com_sun_star_configuration_MissingBootstrapFileException_idl__ +#define __com_sun_star_configuration_MissingBootstrapFileException_idl__ + +#ifndef __com_sun_star_configuration_CannotLoadConfigurationException_idl__ +#include <com/sun/star/configuration/CannotLoadConfigurationException.idl> +#endif + +//============================================================================= + + module com { module sun { module star { module configuration { + +//============================================================================= + /** is thrown when creating a configuration provider fails because a bootstrap file needed to locate the configuration is missing */ published exception MissingBootstrapFileException: com::sun::star::configuration::CannotLoadConfigurationException -{ +{ /// the URL of the bootstrap file that could not be found string BootstrapFileURL; -}; - -//============================================================================= - -}; }; }; }; - -#endif +}; + +//============================================================================= + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/configuration/PropertyHierarchy.idl b/offapi/com/sun/star/configuration/PropertyHierarchy.idl index 3d37344a2c33..dde8be258c96 100644 --- a/offapi/com/sun/star/configuration/PropertyHierarchy.idl +++ b/offapi/com/sun/star/configuration/PropertyHierarchy.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -45,7 +45,7 @@ //============================================================================= -module com { module sun { module star { module configuration { +module com { module sun { module star { module configuration { //============================================================================= /** provides access to and information about properties and subproperties @@ -66,7 +66,7 @@ module com { module sun { module star { module configuration { */ published service PropertyHierarchy { -/** provides access to and information about the immediate properties of an implementation. +/** provides access to and information about the immediate properties of an implementation. */ interface com::sun::star::beans::XPropertySet; @@ -81,12 +81,12 @@ published service PropertyHierarchy interface com::sun::star::beans::XMultiPropertySet; /** provides access to and information about the whole hierarchy - of properties and subproperties of an implementation. + of properties and subproperties of an implementation. */ interface com::sun::star::beans::XHierarchicalPropertySet; /** provides access to and information about the whole hierarchy - of properties and subproperties of an implementation. + of properties and subproperties of an implementation. <p>This interface allows retrieving or setting multiple properties at once. Accesses are guaranteed to occur as single atomic operations even if @@ -99,6 +99,6 @@ published service PropertyHierarchy //============================================================================= -}; }; }; }; +}; }; }; }; #endif diff --git a/offapi/com/sun/star/configuration/SetAccess.idl b/offapi/com/sun/star/configuration/SetAccess.idl index 9b564d90eabd..c2548c2eee1e 100644 --- a/offapi/com/sun/star/configuration/SetAccess.idl +++ b/offapi/com/sun/star/configuration/SetAccess.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -41,7 +41,7 @@ //============================================================================= -module com { module sun { module star { module configuration { +module com { module sun { module star { module configuration { //============================================================================= /** provides access to a dynamic, homogeneous set of values or nested @@ -50,7 +50,7 @@ module com { module sun { module star { module configuration { <p>Also provides information about the template for elements. Allows normalizing externally generated names. </p> - + <p><em>Sets</em> are dynamic containers within the hierarchy.</p> <p>The number and names of contained elements are not fixed in advance, @@ -100,6 +100,6 @@ published service SetAccess //============================================================================= -}; }; }; }; +}; }; }; }; #endif diff --git a/offapi/com/sun/star/configuration/SetElement.idl b/offapi/com/sun/star/configuration/SetElement.idl index f82b642934be..9a5448601ee7 100644 --- a/offapi/com/sun/star/configuration/SetElement.idl +++ b/offapi/com/sun/star/configuration/SetElement.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -45,7 +45,7 @@ //============================================================================= -module com { module sun { module star { module configuration { +module com { module sun { module star { module configuration { //============================================================================= /** provides information about a dynamic element that can be inserted into a @@ -56,7 +56,7 @@ module com { module sun { module star { module configuration { Allows controlling the lifetime of the element. </p> - <p>Set elements may be added to and removed from the hierarchy at runtime. + <p>Set elements may be added to and removed from the hierarchy at runtime. They bear user-defined names. They may exist independently, outside any container. </p> @@ -67,8 +67,8 @@ module com { module sun { module star { module configuration { on an implementation of <type>SetUpdate</type>. Initially, they are not contained in a set object and have no meaningful name. </p> - - <p>While an instance is not contained in a set object, it is owned by + + <p>While an instance is not contained in a set object, it is owned by the client and can be disposed by calling <member scope="com::sun::star::lang">XComponent::dispose()</member>. The name of the object can freely be changed in that situation though without @@ -140,7 +140,7 @@ published service SetElement /** allows controlling or observing the lifetime of the object. - <p>Clients may dispose of the object using + <p>Clients may dispose of the object using <member scope="com::sun::star::lang">XComponent::dispose()</member>, only if the object is currently not contained in a container ( <member scope="com::sun::star::container">XChild::getParent()</member> @@ -181,6 +181,6 @@ published service SetElement //============================================================================= -}; }; }; }; +}; }; }; }; #endif diff --git a/offapi/com/sun/star/configuration/SetUpdate.idl b/offapi/com/sun/star/configuration/SetUpdate.idl index 57c56e7d0231..8dd32e0ed03a 100644 --- a/offapi/com/sun/star/configuration/SetUpdate.idl +++ b/offapi/com/sun/star/configuration/SetUpdate.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -37,7 +37,7 @@ //============================================================================= -module com { module sun { module star { module configuration { +module com { module sun { module star { module configuration { //============================================================================= /** provides write access to a dynamic homogeneous set of values or nested @@ -58,7 +58,7 @@ module com { module sun { module star { module configuration { */ published service SetUpdate { -/** is the basic service providing read access to a <em>set</em> within the +/** is the basic service providing read access to a <em>set</em> within the hierarchy. */ service SetAccess; @@ -100,6 +100,6 @@ published service SetUpdate //============================================================================= -}; }; }; }; +}; }; }; }; #endif diff --git a/offapi/com/sun/star/configuration/SimpleSetAccess.idl b/offapi/com/sun/star/configuration/SimpleSetAccess.idl index 35f8745fe977..c0063753f705 100644 --- a/offapi/com/sun/star/configuration/SimpleSetAccess.idl +++ b/offapi/com/sun/star/configuration/SimpleSetAccess.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -45,16 +45,16 @@ //============================================================================= -module com { module sun { module star { module configuration { +module com { module sun { module star { module configuration { //============================================================================= /** provides access to a dynamic, homogeneous, nonhierarchical set of values or objects. - + <p>Also provides information about the template for elements. Allows normalizing externally generated names. </p> - + <p><em>Sets</em> are dynamic containers.</p> <p>The number and names of contained elements is not fixed in advance, @@ -91,7 +91,7 @@ published service SimpleSetAccess [optional] interface com::sun::star::configuration::XTemplateContainer; /** allows normalizing and denormalizing external names. [optional] - + <p>Elements of a <em>set</em> often correspond to external entities, for example, files, web pages, and people whose names obey different rules and restrictions than names that are valid in the hierarchical naming scheme. @@ -117,6 +117,6 @@ published service SimpleSetAccess //============================================================================= -}; }; }; }; +}; }; }; }; #endif diff --git a/offapi/com/sun/star/configuration/SimpleSetUpdate.idl b/offapi/com/sun/star/configuration/SimpleSetUpdate.idl index c9fb908281d1..2e51ae768c78 100644 --- a/offapi/com/sun/star/configuration/SimpleSetUpdate.idl +++ b/offapi/com/sun/star/configuration/SimpleSetUpdate.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -45,7 +45,7 @@ //============================================================================= -module com { module sun { module star { module configuration { +module com { module sun { module star { module configuration { //============================================================================= /** provides write access to a dynamic, homogeneous, non-hierarchical set of @@ -69,7 +69,7 @@ published service SimpleSetUpdate /** allows inserting, removing, and replacing elements. - <p>This interface extends the interface + <p>This interface extends the interface <type scope="com::sun::star::container">XNameAccess</type> supported by service <type>SimpleSetAccess</type> to allow modifying the container. </p> @@ -107,11 +107,11 @@ published service SimpleSetUpdate <member scope="com::sun::star::container">XNameContainer::removeByName()</member> or replaced using <member scope="com::sun::star::container">XNameContainer::replaceByName()</member> - remain valid and can be reinserted into a set supporting the same template and + remain valid and can be reinserted into a set supporting the same template and even under a different name. </p> - <p>An implementation need not support insertion of objects that were not + <p>An implementation need not support insertion of objects that were not obtained in one of the ways described above. If it does, the implementation must reject elements that do not have the correct structure as described by the template. @@ -121,17 +121,17 @@ published service SimpleSetUpdate /** allows creating an object that can be inserted into this set. [conditional] - <p>This interface shall be implemented by an implementation, + <p>This interface shall be implemented by an implementation, if and only if the element type of the set, as returned by <member scope="com::sun::star::container">XElementAccess::getElementType()</member>, is an object type, such as an interface. - </p> + </p> <p>Using <member scope="com::sun::star::lang">XSingleServiceFactory::createInstance()</member> an instance of the element template of this set is created. If the set supports multiple templates or variations of the basic template, a default variant of the basic template is instantiated. If an implementation supports - variations, they may be specified by passing arguments to + variations, they may be specified by passing arguments to <member scope="com::sun::star::lang">XSingleServiceFactory::createInstanceWithArguments()</member>. There are no predefined arguments for all versions of this service. </p> @@ -147,19 +147,19 @@ published service SimpleSetUpdate /** allows creating various objects that can be inserted into this set. [optional] - <p>This interface may be implemented by an implementation of + <p>This interface may be implemented by an implementation of service SetUpdate to support creating elements from other than the basic element template. An example of this would be an implementation that supports inheritance, allowing the use of templates derived from the basic template by extension. - </p> + </p> - <p>This interface may only be implemented if the element type of the set + <p>This interface may only be implemented if the element type of the set (as returned by <member scope="com::sun::star::container">XElementAccess::getElementType()</member>) is an object type, such as an interface. An implementation should also implement interface <type>XTemplateContainer</type> which is optional in this service. - </p> + </p> <p>The service identifier argument passed to <member scope="com::sun::star::lang">XMultiServiceFactory::createInstance()</member> @@ -170,7 +170,7 @@ published service SimpleSetUpdate as a service identifier, in which case the result shall be the same as if the corresponding member of <type scope="com::sun::star::lang">XSingleServiceFactory</type> had been called. - </p> + </p> */ [optional] interface com::sun::star::lang::XMultiServiceFactory; @@ -179,6 +179,6 @@ published service SimpleSetUpdate //============================================================================= -}; }; }; }; +}; }; }; }; #endif diff --git a/offapi/com/sun/star/configuration/UpdateRootElement.idl b/offapi/com/sun/star/configuration/UpdateRootElement.idl index 16ffa9450a08..d185183dad1c 100644 --- a/offapi/com/sun/star/configuration/UpdateRootElement.idl +++ b/offapi/com/sun/star/configuration/UpdateRootElement.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -37,12 +37,12 @@ //============================================================================= -module com { module sun { module star { module configuration { +module com { module sun { module star { module configuration { //============================================================================= /** provides update control for a hierarchy of configuration items and information about the hierarchy as a whole as well as its root. - + <p>Extends <type>AccessRootElement</type> by adding support for collecting changes and applying them to a backend store as a single batch. </p> @@ -85,7 +85,7 @@ published service UpdateRootElement reports all changes within the hierarchy that are done through (direct or indirect) descendants of this element. The same set of changes is committed to persistent storage and/or made visible to other objects accessing the same - data set, when + data set, when <member scope="com::sun::star::util">XChangesBatch::commitChanges()</member> is invoked. </p> @@ -105,6 +105,6 @@ published service UpdateRootElement //============================================================================= -}; }; }; }; +}; }; }; }; #endif diff --git a/offapi/com/sun/star/configuration/XTemplateContainer.idl b/offapi/com/sun/star/configuration/XTemplateContainer.idl index 84331c660c19..1ad7308dbe2b 100644 --- a/offapi/com/sun/star/configuration/XTemplateContainer.idl +++ b/offapi/com/sun/star/configuration/XTemplateContainer.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -24,57 +24,57 @@ * for a copy of the LGPLv3 License. * ************************************************************************/ -#ifndef __com_sun_star_configuration_XTemplateContainer_idl__ -#define __com_sun_star_configuration_XTemplateContainer_idl__ - -#ifndef __com_sun_star_uno_XInterface_idl__ -#include <com/sun/star/uno/XInterface.idl> -#endif - -//============================================================================= - - module com { module sun { module star { module configuration { - -//============================================================================= - +#ifndef __com_sun_star_configuration_XTemplateContainer_idl__ +#define __com_sun_star_configuration_XTemplateContainer_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +//============================================================================= + + module com { module sun { module star { module configuration { + +//============================================================================= + /** is implemented by objects that contain instances of a named template to provide information about the template. - <p> An implementation will also implement + <p> An implementation will also implement <type scope="com::sun::star::lang">XSingleServiceFactory</type>, in which case that interface creates instances of the specified template. </p> - <p> If multiple templates are supported, the supported factory interface may be + <p> If multiple templates are supported, the supported factory interface may be <type scope="com::sun::star::lang">XMultiServiceFactory</type>, in which case - the <atom>string</atom> returned from - <member>XTemplateContainer::getElementTemplateName()</member> can be used as + the <atom>string</atom> returned from + <member>XTemplateContainer::getElementTemplateName()</member> can be used as the service name argument. </p> @see XTemplateInstance */ published interface XTemplateContainer: com::sun::star::uno::XInterface -{ - //------------------------------------------------------------------------- - +{ + //------------------------------------------------------------------------- + /** retrieves the name of the template - - <p> If instances of multiple templates are accepted by the container, + + <p> If instances of multiple templates are accepted by the container, this is the name of the basic or primary template. </p> - <p> Instances of the template must be created + <p> Instances of the template must be created using an appropriate factory. </p> - @returns - the name of the (default) template for elements. + @returns + the name of the (default) template for elements. */ - string getElementTemplateName(); - -}; - -//============================================================================= - -}; }; }; }; + string getElementTemplateName(); -#endif +}; + +//============================================================================= + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/configuration/XTemplateInstance.idl b/offapi/com/sun/star/configuration/XTemplateInstance.idl index f624ce8705f7..e2b32fdbfedf 100644 --- a/offapi/com/sun/star/configuration/XTemplateInstance.idl +++ b/offapi/com/sun/star/configuration/XTemplateInstance.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -24,47 +24,47 @@ * for a copy of the LGPLv3 License. * ************************************************************************/ -#ifndef __com_sun_star_configuration_XTemplateInstance_idl__ -#define __com_sun_star_configuration_XTemplateInstance_idl__ - -#ifndef __com_sun_star_uno_XInterface_idl__ -#include <com/sun/star/uno/XInterface.idl> -#endif - -//============================================================================= - - module com { module sun { module star { module configuration { - -//============================================================================= - -/** is implemented by objects that are instances of a named template to provide +#ifndef __com_sun_star_configuration_XTemplateInstance_idl__ +#define __com_sun_star_configuration_XTemplateInstance_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +//============================================================================= + + module com { module sun { module star { module configuration { + +//============================================================================= + +/** is implemented by objects that are instances of a named template to provide information about the template. - <p> Template names are similar to service names, but apply to structure and + <p> Template names are similar to service names, but apply to structure and content, rather than to type. </p> - <p> Often a template description can be retrieved from a repository and then be - interpreted by a factory object. Templates provide a means to build + <p> Often a template description can be retrieved from a repository and then be + interpreted by a factory object. Templates provide a means to build new kinds of objects dynamically. </p> @see XTemplateContainer */ published interface XTemplateInstance: com::sun::star::uno::XInterface -{ - //------------------------------------------------------------------------- - +{ + //------------------------------------------------------------------------- + /** retrieves the name of the template - - @returns - the name of the template this object was built from or conforms to. + + @returns + the name of the template this object was built from or conforms to. */ - string getTemplateName(); - -}; - -//============================================================================= - -}; }; }; }; + string getTemplateName(); -#endif +}; + +//============================================================================= + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/configuration/backend/AuthenticationFailedException.idl b/offapi/com/sun/star/configuration/backend/AuthenticationFailedException.idl index 32ee9cf05f2f..82bec312a37c 100644 --- a/offapi/com/sun/star/configuration/backend/AuthenticationFailedException.idl +++ b/offapi/com/sun/star/configuration/backend/AuthenticationFailedException.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -36,14 +36,14 @@ module com { module sun { module star { module configuration { module backend { /** - Exception thrown when authentication to the underlying backend fails + Exception thrown when authentication to the underlying backend fails due to an unknown user-id or invalid credentials. @since OOo 1.1.2 */ published exception AuthenticationFailedException : BackendSetupException { } ; - + } ; } ; } ; } ; } ; diff --git a/offapi/com/sun/star/configuration/backend/Backend.idl b/offapi/com/sun/star/configuration/backend/Backend.idl index 0932291c74bd..6a5a4212e84a 100644 --- a/offapi/com/sun/star/configuration/backend/Backend.idl +++ b/offapi/com/sun/star/configuration/backend/Backend.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -29,72 +29,72 @@ #ifndef __com_sun_star_configuration_backend_XBackend_idl__ #include <com/sun/star/configuration/backend/XBackend.idl> -#endif +#endif #ifndef __com_sun_star_configuration_backend_XBackendEntities_idl__ #include <com/sun/star/configuration/backend/XBackendEntities.idl> -#endif +#endif #ifndef __com_sun_star_configuration_backend_XSchemaSupplier_idl__ #include <com/sun/star/configuration/backend/XSchemaSupplier.idl> -#endif +#endif -//============================================================================= +//============================================================================= module com { module sun { module star { module configuration { module backend { -//============================================================================= +//============================================================================= /** - provides access to a configuration database composed of one or more + provides access to a configuration database composed of one or more storage backends containing settings used by software modules. - <p> Configuration data is organized into layers which are selected - by components and entities. + <p> Configuration data is organized into layers which are selected + by components and entities. </p> - <p> Components are characterized by configuration schemas. - A component contains configuration data for a particular + <p> Components are characterized by configuration schemas. + A component contains configuration data for a particular application domain or software module. </p> <p> Entities are organised hierarchically in organisations, - groups, roles and individual users. Each element of the associated + groups, roles and individual users. Each element of the associated hierarchy corresponds to a layer that applies to an entity. </p> - <p> A layer contains data for multiple components + <p> A layer contains data for multiple components associated to a single entity. <p> - + @since OOo 1.1.2 */ -published service Backend +published service Backend { - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- /** provides access to configuration schemas. */ interface XSchemaSupplier ; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- /** provides access to the layer data. */ interface XBackend ; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- /** provides information about supported and special entities. */ [optional] interface XBackendEntities ; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- } ; -//============================================================================= +//============================================================================= -} ; } ; } ; } ; } ; +} ; } ; } ; } ; } ; -#endif +#endif diff --git a/offapi/com/sun/star/configuration/backend/BackendAccessException.idl b/offapi/com/sun/star/configuration/backend/BackendAccessException.idl index d5c80d01ee0b..cfe15292b54c 100644 --- a/offapi/com/sun/star/configuration/backend/BackendAccessException.idl +++ b/offapi/com/sun/star/configuration/backend/BackendAccessException.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -44,7 +44,7 @@ module backend { */ published exception BackendAccessException : ::com::sun::star::lang::WrappedTargetException { } ; - + } ; } ; } ; } ; } ; diff --git a/offapi/com/sun/star/configuration/backend/BackendAdapter.idl b/offapi/com/sun/star/configuration/backend/BackendAdapter.idl index 176abb2d1ce0..dfb881b76bf0 100644 --- a/offapi/com/sun/star/configuration/backend/BackendAdapter.idl +++ b/offapi/com/sun/star/configuration/backend/BackendAdapter.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -29,37 +29,37 @@ #ifndef __com_sun_star_configuration_backend_Backend_idl__ #include <com/sun/star/configuration/backend/Backend.idl> -#endif +#endif #ifndef __com_sun_star_configuration_backend_XBackendEntities_idl__ #include <com/sun/star/configuration/backend/XBackendEntities.idl> -#endif +#endif #ifndef __com_sun_star_lang_XInitialization_idl__ #include <com/sun/star/lang/XInitialization.idl> -#endif +#endif -//============================================================================= +//============================================================================= module com { module sun { module star { module configuration { module backend { -//============================================================================= +//============================================================================= /** - implements <type>Backend</type> retrieving data + implements <type>Backend</type> retrieving data from a <type>SingleBackend</type>. - + @since OOo 1.1.2 */ published service BackendAdapter { - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- /** provides access to configuration data. */ service Backend ; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- /** This interface, that is optional in <type>Backend</type>, is @@ -67,28 +67,28 @@ published service BackendAdapter */ interface XBackendEntities ; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- /** allows initializing the backend to use. <p>If this interface is present, a <type>SingleBackend</type> - may be passed, that is used to access the data. - Also a <type scope="com::sun::star::configuration::bootstrap">BootstrapContext</type> + may be passed, that is used to access the data. + Also a <type scope="com::sun::star::configuration::bootstrap">BootstrapContext</type> can be passed, that provides further settings for the backend. </p> - <p>If this interface is missing, the real backend to use is determined + <p>If this interface is missing, the real backend to use is determined from the <type scope="com::sun::star::uno">XComponentContext</type>. </p> */ [optional] interface com::sun::star::lang::XInitialization ; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- } ; -//============================================================================= +//============================================================================= -} ; } ; } ; } ; } ; +} ; } ; } ; } ; } ; -#endif +#endif diff --git a/offapi/com/sun/star/configuration/backend/BackendSetupException.idl b/offapi/com/sun/star/configuration/backend/BackendSetupException.idl index c5ce0d0c47cd..3e94c6959c5b 100644 --- a/offapi/com/sun/star/configuration/backend/BackendSetupException.idl +++ b/offapi/com/sun/star/configuration/backend/BackendSetupException.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -43,16 +43,16 @@ module backend { @since OOo 1.1.2 */ published exception BackendSetupException : ::com::sun::star::configuration::CannotLoadConfigurationException { - + /** The exception that is raised by the underlying backend implementation. - <p>May be a numeric error code, a message <atom>string</atom> or <void/>, - if the original exception is not represented as a + <p>May be a numeric error code, a message <atom>string</atom> or <void/>, + if the original exception is not represented as a <type scope="com::sun::star::uno">Exception</type>. </p> */ - any BackendException; + any BackendException; } ; - + } ; } ; } ; } ; } ; diff --git a/offapi/com/sun/star/configuration/backend/CannotConnectException.idl b/offapi/com/sun/star/configuration/backend/CannotConnectException.idl index 04a1d44b9c03..965f196736f2 100644 --- a/offapi/com/sun/star/configuration/backend/CannotConnectException.idl +++ b/offapi/com/sun/star/configuration/backend/CannotConnectException.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -36,7 +36,7 @@ module com { module sun { module star { module configuration { module backend { /** - Exception thrown when a connection to the underlying backend + Exception thrown when a connection to the underlying backend cannot be established. <p> Examples of this include @@ -46,13 +46,13 @@ module backend { <li>Backend is unavailable temporarily or permanently.</li> <li>Internal failure of the backend access layer.</li> <ul/> - </p> + </p> @since OOo 1.1.2 */ published exception CannotConnectException : BackendSetupException { } ; - + } ; } ; } ; } ; } ; diff --git a/offapi/com/sun/star/configuration/backend/ComponentChangeEvent.idl b/offapi/com/sun/star/configuration/backend/ComponentChangeEvent.idl index afe42f257a83..c4e79272853e 100644 --- a/offapi/com/sun/star/configuration/backend/ComponentChangeEvent.idl +++ b/offapi/com/sun/star/configuration/backend/ComponentChangeEvent.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -25,34 +25,34 @@ * ************************************************************************/ -#ifndef __com_sun_star_configuration_backend_ComponentChangeEvent_idl__ -#define __com_sun_star_configuration_backend_ComponentChangeEvent_idl__ - -#ifndef __com_sun_star_lang_EventObject_idl__ -#include <com/sun/star/lang/EventObject.idl> -#endif -//============================================================================= - -module com { module sun { module star { module configuration { module backend { - -//============================================================================= - +#ifndef __com_sun_star_configuration_backend_ComponentChangeEvent_idl__ +#define __com_sun_star_configuration_backend_ComponentChangeEvent_idl__ + +#ifndef __com_sun_star_lang_EventObject_idl__ +#include <com/sun/star/lang/EventObject.idl> +#endif +//============================================================================= + +module com { module sun { module star { module configuration { module backend { + +//============================================================================= + /** This event is fired when a change becomes effective on the source of the event - @see XBackendChangesNotifier - + @see XBackendChangesNotifier + */ struct ComponentChangeEvent: ::com::sun::star::lang::EventObject -{ - //------------------------------------------------------------------------- +{ + //------------------------------------------------------------------------- /** The name of the Component that changed */ string Component; - -}; - -//============================================================================= - -}; }; }; }; }; - -#endif + +}; + +//============================================================================= + +}; }; }; }; }; + +#endif diff --git a/offapi/com/sun/star/configuration/backend/ConnectionLostException.idl b/offapi/com/sun/star/configuration/backend/ConnectionLostException.idl index f6213e9327c5..e39e894252a4 100644 --- a/offapi/com/sun/star/configuration/backend/ConnectionLostException.idl +++ b/offapi/com/sun/star/configuration/backend/ConnectionLostException.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -36,18 +36,18 @@ module com { module sun { module star { module configuration { module backend { /** - Exception thrown when the connection to the underlying backend was lost + Exception thrown when the connection to the underlying backend was lost irrecoverably. - <p> Any future attempts to access data from the backend through this object + <p> Any future attempts to access data from the backend through this object will also fail. - </p> + </p> @since OOo 1.1.2 */ published exception ConnectionLostException : BackendAccessException { } ; - + } ; } ; } ; } ; } ; diff --git a/offapi/com/sun/star/configuration/backend/CopyImporter.idl b/offapi/com/sun/star/configuration/backend/CopyImporter.idl index ab790ba521e1..4f3507b94d98 100644 --- a/offapi/com/sun/star/configuration/backend/CopyImporter.idl +++ b/offapi/com/sun/star/configuration/backend/CopyImporter.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -29,45 +29,45 @@ #ifndef __com_sun_star_configuration_backend_Importer_idl__ #include <com/sun/star/configuration/backend/Importer.idl> -#endif +#endif #ifndef __com_sun_star_lang_XInitialization_idl__ #include <com/sun/star/lang/XInitialization.idl> -#endif +#endif -//============================================================================= +//============================================================================= module com { module sun { module star { module configuration { module backend { -//============================================================================= +//============================================================================= -/** +/** imports data into a configuration layer by copying over existing data. - + @since OOo 1.1.2 */ published service CopyImporter { - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- /** allows importing configuration data into a backend. - - <p> In this implementation, the changes are copied over any - <type>XLayer</type> data that already exists in the <type>Backend</type>, + + <p> In this implementation, the changes are copied over any + <type>XLayer</type> data that already exists in the <type>Backend</type>, replacing it completely. </p> */ service Importer ; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- - /** allows initializing the implementation with settings that control + /** allows initializing the implementation with settings that control its behavior . - <p> This interface, which is optional in <type>Importer</type> - is mandatory in this service and supports the following arguments - which must be provided as + <p> This interface, which is optional in <type>Importer</type> + is mandatory in this service and supports the following arguments + which must be provided as <type scope="com::sun::star::beans">NamedValue</type>: <dl> <dt><code>Overwrite</code> : <atom>boolean</atom></dt> @@ -75,15 +75,15 @@ published service CopyImporter only if the existing layer is empty. </dd> </dl> - </p> + </p> */ interface com::sun::star::lang::XInitialization ; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- } ; -//============================================================================= +//============================================================================= -} ; } ; } ; } ; } ; +} ; } ; } ; } ; } ; -#endif +#endif diff --git a/offapi/com/sun/star/configuration/backend/DataImporter.idl b/offapi/com/sun/star/configuration/backend/DataImporter.idl index a3b039e24ca0..45c445f6d9e9 100644 --- a/offapi/com/sun/star/configuration/backend/DataImporter.idl +++ b/offapi/com/sun/star/configuration/backend/DataImporter.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -29,86 +29,86 @@ #ifndef __com_sun_star_task_XJob_idl__ #include <com/sun/star/task/XJob.idl> -#endif +#endif -//============================================================================= +//============================================================================= module com { module sun { module star { module configuration { module backend { -//============================================================================= +//============================================================================= /** allows importing data from one configuration repository into another. . - + @since OOo 1.1.2 */ published service DataImporter { - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- /** allows running an import job - <p> The source and destination repositories are selected by arguments + <p> The source and destination repositories are selected by arguments passed to - <member scope="com::sun::star::task">XJob::execute()</member>. - The names and meanings of such arguments depend on + <member scope="com::sun::star::task">XJob::execute()</member>. + The names and meanings of such arguments depend on the implementation. Each implementation must document such arguments. </p> - - <p> Implementations may return a value from + + <p> Implementations may return a value from <member scope="com::sun::star::task">XJob::execute()</member> - that indicates the status of job execution. The type and meaning of - such status indicators depend on the implementation. + that indicates the status of job execution. The type and meaning of + such status indicators depend on the implementation. </p> - <p>If <void/> or <TRUE/> is returned, this indicates successful - execution. If an - <type scope="com::sun::star::uno">Exception</type> is returned, - it represents an error condition encountered during execution. + <p>If <void/> or <TRUE/> is returned, this indicates successful + execution. If an + <type scope="com::sun::star::uno">Exception</type> is returned, + it represents an error condition encountered during execution. </p> <p> The following arguments to <member scope="com::sun::star::task">XJob::execute()</member> - should be supported by implementations. Implementations must document + should be supported by implementations. Implementations must document a failure to support any of these arguments: <dl> <dt><code>ImporterService</code> : <atom >string</atom></dt> - <dd>A service or implementation name used to instantiate the - <type>Importer</type> to use for importing. If this parameter - is missing, the implementation selects an appropriate importer. + <dd>A service or implementation name used to instantiate the + <type>Importer</type> to use for importing. If this parameter + is missing, the implementation selects an appropriate importer. By default, a <type>MergeImporter</type> should be used. </dd> <dt><code>OverwriteExisting</code> : <atom >boolean</atom></dt> - <dd>If <TRUE/>, specifies that no existing data should be - overwritten by the import. If the <type>Importer</type> used - does not support such protection, an error may be raised. - If some data is not imported, because there is existing - data, this is indicated by returning an appropriate exception. + <dd>If <TRUE/>, specifies that no existing data should be + overwritten by the import. If the <type>Importer</type> used + does not support such protection, an error may be raised. + If some data is not imported, because there is existing + data, this is indicated by returning an appropriate exception. </dd> <dt><code>TruncateExisting</code> : <atom >boolean</atom></dt> - <dd>If <TRUE/>, specifies that existing data should be - discarded and replaced by the imported data. - If the <type>Importer</type> used does not support this - operation, an error may be raised. - By default, a <type>CopyImporter</type> is used to perform + <dd>If <TRUE/>, specifies that existing data should be + discarded and replaced by the imported data. + If the <type>Importer</type> used does not support this + operation, an error may be raised. + By default, a <type>CopyImporter</type> is used to perform truncating import. </dd> <dt><code>Entity</code> : <atom >string</atom></dt> - <dd>An identifier for the entity in the destination backend for - which the imported data should apply. The value will be passed + <dd>An identifier for the entity in the destination backend for + which the imported data should apply. The value will be passed to <member>XLayerImporter::importLayerForEntity()</member>. - If this parameter is missing, the implementation uses + If this parameter is missing, the implementation uses <member>XLayerImporter::importLayer()</member> instead. </dd> <dt><code>Component</code> : <atom >string</atom></dt> - <dd>Names the component for which to import data. If this - parameter is missing, the selection of data to import depends - on implementation-specific parameters. + <dd>Names the component for which to import data. If this + parameter is missing, the selection of data to import depends + on implementation-specific parameters. </dd> <dt><code>LayerFilter</code> : <type >LayerFilter</type></dt> - <dd>A filter to transform data during import. This parameter is - optional. If this parameter is missing, data will be imported - unaltered. <em>Support for this parameter is optional.</em> - If the implementation does not support a filter it will raise an + <dd>A filter to transform data during import. This parameter is + optional. If this parameter is missing, data will be imported + unaltered. <em>Support for this parameter is optional.</em> + If the implementation does not support a filter it will raise an <type scope="com::sun::star::lang">IllegalArgumentException</type>. </dd> </dl> @@ -117,11 +117,11 @@ published service DataImporter */ interface com::sun::star::task::XJob ; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- } ; -//============================================================================= +//============================================================================= -} ; } ; } ; } ; } ; +} ; } ; } ; } ; } ; -#endif +#endif diff --git a/offapi/com/sun/star/configuration/backend/DefaultBackend.idl b/offapi/com/sun/star/configuration/backend/DefaultBackend.idl index 38ddc1e034e7..f56bde41274e 100644 --- a/offapi/com/sun/star/configuration/backend/DefaultBackend.idl +++ b/offapi/com/sun/star/configuration/backend/DefaultBackend.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -29,36 +29,36 @@ #ifndef __com_sun_star_configuration_backend_Backend_idl__ #include <com/sun/star/configuration/backend/Backend.idl> -#endif +#endif -//============================================================================= +//============================================================================= module com { module sun { module star { module configuration { module backend { -//============================================================================= +//============================================================================= /** - is a <type>DefaultBackend</type>, that is + is a <type>DefaultBackend</type>, that is the default <type>DefaultBackend</type> for its <type scope="com::sun::star::uno">XComponentContext</type>. - + <p>This object is accessible as singleton within the context</p>. @since OOo 1.1.2 */ -service DefaultBackend +service DefaultBackend { - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- - /** characterizes the functionality. + /** characterizes the functionality. */ service Backend ; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- } ; -//============================================================================= +//============================================================================= -} ; } ; } ; } ; } ; +} ; } ; } ; } ; } ; -#endif +#endif diff --git a/offapi/com/sun/star/configuration/backend/HierarchyBrowser.idl b/offapi/com/sun/star/configuration/backend/HierarchyBrowser.idl index 22f07f63b37b..4cd33be6b39a 100644 --- a/offapi/com/sun/star/configuration/backend/HierarchyBrowser.idl +++ b/offapi/com/sun/star/configuration/backend/HierarchyBrowser.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -29,57 +29,57 @@ #ifndef __com_sun_star_task_XJob_idl__ #include <com/sun/star/task/XJob.idl> -#endif +#endif -//============================================================================= +//============================================================================= module com { module sun { module star { module configuration { module backend { -//============================================================================= +//============================================================================= /** allows scanning a configuration data repository for available components . - + @since OOo 1.1.2 */ -published service HierarchyBrowser +published service HierarchyBrowser { - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- /** allows executing a scan of the repository <p> The repository to browse is selected by arguments passed to - <member scope="com::sun::star::task">XJob::execute()</member>. - The names and meanings of such arguments depend on + <member scope="com::sun::star::task">XJob::execute()</member>. + The names and meanings of such arguments depend on the implementation. Each implementation must document such arguments. </p> - + <p> The following argument to <member scope="com::sun::star::task">XJob::execute()</member> must be supported by all implementations: <dl> <dt><code>ExcludeComponents</code> : <atom dim="[]">string</atom> or <atom >string</atom></dt> - <dd>A component or list of components that should be skipped - and excluded from the result. If this argument appears multiple + <dd>A component or list of components that should be skipped + and excluded from the result. If this argument appears multiple times it is handled cumulatively. </dd> </dl> </p> - <p> The return value of - <member scope="com::sun::star::task">XJob::execute()</member> - is a list of components found. The format in which components are - returned may depend on the implementation. Each implementation - should support returning component identifiers that are compatible + <p> The return value of + <member scope="com::sun::star::task">XJob::execute()</member> + is a list of components found. The format in which components are + returned may depend on the implementation. Each implementation + should support returning component identifiers that are compatible with some implementation of <type>Backend</type>. </p> */ interface com::sun::star::task::XJob ; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- } ; -//============================================================================= +//============================================================================= -} ; } ; } ; } ; } ; +} ; } ; } ; } ; } ; -#endif +#endif diff --git a/offapi/com/sun/star/configuration/backend/Importer.idl b/offapi/com/sun/star/configuration/backend/Importer.idl index 8cb74626c6be..8d5f6cbc68a1 100644 --- a/offapi/com/sun/star/configuration/backend/Importer.idl +++ b/offapi/com/sun/star/configuration/backend/Importer.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -29,59 +29,59 @@ #ifndef __com_sun_star_lang_XInitialization_idl__ #include <com/sun/star/lang/XInitialization.idl> -#endif +#endif #ifndef __com_sun_star_configuration_backend_XLayerImporter_idl__ #include <com/sun/star/configuration/backend/XLayerImporter.idl> -#endif +#endif -//============================================================================= +//============================================================================= module com { module sun { module star { module configuration { module backend { -//============================================================================= +//============================================================================= -/** +/** imports data into a configuration layer. - <p> The configuration changes are read from a <type>XLayer</type> + <p> The configuration changes are read from a <type>XLayer</type> and stored into a <type>Backend</type>. </p> - + @since OOo 1.1.2 */ published service Importer { - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- /** allows importing configuration data into a backend. */ interface XLayerImporter ; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- - /** allows initializing the implementation with settings that control + /** allows initializing the implementation with settings that control its behavior . - <p> Arguments are provided as - <type scope="com::sun::star::beans">NamedValue</type>. + <p> Arguments are provided as + <type scope="com::sun::star::beans">NamedValue</type>. Implementations specify which arguments they support. - + <dl> <dt><code>Notify</code> : <atom>boolean</atom></dt> <dd>If <TRUE/>, specifies that the backend should trigger notification to its listeners. </dd> </dl> - </p> + </p> */ [optional] interface com::sun::star::lang::XInitialization ; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- } ; -//============================================================================= +//============================================================================= -} ; } ; } ; } ; } ; +} ; } ; } ; } ; } ; -#endif +#endif diff --git a/offapi/com/sun/star/configuration/backend/InsufficientAccessRightsException.idl b/offapi/com/sun/star/configuration/backend/InsufficientAccessRightsException.idl index 81da4911437b..2a21eec34560 100644 --- a/offapi/com/sun/star/configuration/backend/InsufficientAccessRightsException.idl +++ b/offapi/com/sun/star/configuration/backend/InsufficientAccessRightsException.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -36,7 +36,7 @@ module com { module sun { module star { module configuration { module backend { /** - Exception thrown when access to the underlying backend fails because of + Exception thrown when access to the underlying backend fails because of insufficient access rights to some needed resource. <p> Examples of this include @@ -47,13 +47,13 @@ module backend { <li>Missing access to personal data.</li> <li>Missing write access when updating data.</li> </ul> - </p> - + </p> + @since OOo 1.1.2 */ published exception InsufficientAccessRightsException : BackendAccessException { } ; - + } ; } ; } ; } ; } ; diff --git a/offapi/com/sun/star/configuration/backend/InteractionHandler.idl b/offapi/com/sun/star/configuration/backend/InteractionHandler.idl index 82a3595a6b08..ac73fda6292b 100644 --- a/offapi/com/sun/star/configuration/backend/InteractionHandler.idl +++ b/offapi/com/sun/star/configuration/backend/InteractionHandler.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite diff --git a/offapi/com/sun/star/configuration/backend/InvalidAuthenticationMechanismException.idl b/offapi/com/sun/star/configuration/backend/InvalidAuthenticationMechanismException.idl index 50d9650636ff..ffa243b70167 100644 --- a/offapi/com/sun/star/configuration/backend/InvalidAuthenticationMechanismException.idl +++ b/offapi/com/sun/star/configuration/backend/InvalidAuthenticationMechanismException.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -36,7 +36,7 @@ module com { module sun { module star { module configuration { module backend { /** - Exception thrown when authentication to the underlying backend fails + Exception thrown when authentication to the underlying backend fails because the configured authentication mechanism is not supported by the backend or no valid mechanism can be negotiated. @@ -44,7 +44,7 @@ module backend { */ published exception InvalidAuthenticationMechanismException : BackendSetupException { } ; - + } ; } ; } ; } ; } ; diff --git a/offapi/com/sun/star/configuration/backend/Layer.idl b/offapi/com/sun/star/configuration/backend/Layer.idl index 8b9429810b15..204166f198c6 100644 --- a/offapi/com/sun/star/configuration/backend/Layer.idl +++ b/offapi/com/sun/star/configuration/backend/Layer.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -74,31 +74,31 @@ published service Layer //-------------------------------------------------------------------------- /** - provides read access to sublayers accessible through an + provides read access to sublayers accessible through an additional criterion (for instance the locale they contain data for). */ [optional] interface XCompositeLayer ; //-------------------------------------------------------------------------- - /** + /** provides a way to detect changes to the layer. - <p> Timestamps should be considered as opaque markers and - can only safely be compared for equality and - only to timestamps generated by the same implementation. - When the content of the Layer changes, + <p> Timestamps should be considered as opaque markers and + can only safely be compared for equality and + only to timestamps generated by the same implementation. + When the content of the Layer changes, the timestamp is guaranteed to change to a different value. </p> - <p> The timestamp format depends on the implementation. - If the timestamp is a representation of the time of the last change, + <p> The timestamp format depends on the implementation. + If the timestamp is a representation of the time of the last change, the recommended format is "YYYYMMDDhhmmssZ". </p> */ [optional] interface com::sun::star::util::XTimeStamped ; - + //-------------------------------------------------------------------------- - + /** The URL of the layer data. diff --git a/offapi/com/sun/star/configuration/backend/LayerDescriber.idl b/offapi/com/sun/star/configuration/backend/LayerDescriber.idl index 1f6ae54f2c5f..af3cc0487f06 100644 --- a/offapi/com/sun/star/configuration/backend/LayerDescriber.idl +++ b/offapi/com/sun/star/configuration/backend/LayerDescriber.idl @@ -7,35 +7,35 @@ #ifndef __com_sun_star_uno_XInterface_idl__ #include <com/sun/star/uno/XInterface.idl> -#endif +#endif -//============================================================================= +//============================================================================= module com { module sun { module star { module configuration { module backend { -//============================================================================= +//============================================================================= -/** +/** describe the contents of a layer to an XLayerHander object. The contents of the layer is contained in the sequence of PropertyInfo structures @see PropertyInfo - + */ -service LayerDescriber +service LayerDescriber { - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- - /** + /** describes a set of configuration data to an XLayerHandler Object. */ interface com::sun::star::configuration::backend::XLayerContentDescriber ; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- -//============================================================================= +//============================================================================= } ; -} ; } ; } ; } ; } ; -#endif +} ; } ; } ; } ; } ; +#endif diff --git a/offapi/com/sun/star/configuration/backend/LayerFilter.idl b/offapi/com/sun/star/configuration/backend/LayerFilter.idl index ec5a209aa8ac..4f6515facb38 100644 --- a/offapi/com/sun/star/configuration/backend/LayerFilter.idl +++ b/offapi/com/sun/star/configuration/backend/LayerFilter.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -45,9 +45,9 @@ module com { module sun { module star { module configuration { module backend { /** provides a filtered version of a configuration data <type>Layer</type>. - <p> A layer filter wraps a source <type>XLayer</type> object and + <p> A layer filter wraps a source <type>XLayer</type> object and provides access to a filtered version of its data. - The data read from the filter usually is produced from the source data + The data read from the filter usually is produced from the source data by adding and removing elements or modifying values. </p> @@ -63,7 +63,7 @@ published service LayerFilter /** provides read access to the filtered contents. - <p> Method <member>XLayer::readData</member> will render a filtered version + <p> Method <member>XLayer::readData</member> will render a filtered version of the data produced by the same method of the source object. </p> */ @@ -73,11 +73,11 @@ published service LayerFilter /** provides a means to set the source data for the filter. - + <p> Call <method scope="com::sun::star::lang">XInitialization::initialize</method>() with a single argument of type <type scope="com::sun::star::beans">NamedValue</type>, where <member scope="com::sun::star::beans">NamedValue::Name</member> is <code>"Source"</code> - and <member scope="com::sun::star::beans">NamedValue::Value</member> + and <member scope="com::sun::star::beans">NamedValue::Value</member> is an object implementing <type>XLayer</type>. </p> */ diff --git a/offapi/com/sun/star/configuration/backend/LayerUpdateMerger.idl b/offapi/com/sun/star/configuration/backend/LayerUpdateMerger.idl index bff3c26c92a8..0ecccdb2e05d 100644 --- a/offapi/com/sun/star/configuration/backend/LayerUpdateMerger.idl +++ b/offapi/com/sun/star/configuration/backend/LayerUpdateMerger.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -29,26 +29,26 @@ #ifndef __com_sun_star_lang_XInitialization_idl__ #include <com/sun/star/lang/XInitialization.idl> -#endif +#endif #ifndef __com_sun_star_configuration_backend_XUpdateHandler_idl__ #include <com/sun/star/configuration/backend/XUpdateHandler.idl> -#endif +#endif -//============================================================================= +//============================================================================= module com { module sun { module star { module configuration { module backend { -//============================================================================= +//============================================================================= -/** +/** applies updates to a configuration layer. - <p> The configuration layer data is read from a <type>XLayer</type> - and the changed layer is provided as <type>XLayer</type> again or + <p> The configuration layer data is read from a <type>XLayer</type> + and the changed layer is provided as <type>XLayer</type> again or described to a <type>XLayerHandler</type>. </p> - + @see com::sun::star::configuration::backend::UpdatableLayer Service describes a layer and accepts a changed layer.. @@ -56,25 +56,25 @@ module com { module sun { module star { module configuration { module backend { */ published service LayerUpdateMerger { - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- /** accepts events describing the changes. */ interface com::sun::star::configuration::backend::XUpdateHandler ; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- /** allows initializing layer data source and target. <p> Both source and target of the update can be provided by passing a - <type>XUpdatableLayer</type> object. Alternatively they can be + <type>XUpdatableLayer</type> object. Alternatively they can be provided individually by providing a <type>XLayer</type> object as - data source and an <type>XLayerHandler</type> object to receive the + data source and an <type>XLayerHandler</type> object to receive the updated data. - </p> - <p> Implementations can provide more arguments to finetune the behavior. - Such arguments are provided as - <type scope="com::sun::star::beans">NamedValue</type>. + </p> + <p> Implementations can provide more arguments to finetune the behavior. + Such arguments are provided as + <type scope="com::sun::star::beans">NamedValue</type>. Implementations should support the following named arguments: <dl> <dt><code>Overwrite</code> : <atom>boolean</atom></dt> @@ -82,8 +82,8 @@ published service LayerUpdateMerger only if the existing layer is empty. </dd> <dt><code>Truncate</code> : <atom>boolean</atom></dt> - <dd>If <TRUE/> requests that changes should not be merged onto - existing data, but that the changes should be applied + <dd>If <TRUE/> requests that changes should not be merged onto + existing data, but that the changes should be applied to a layer that is completely empty. </dd> </dl> @@ -91,11 +91,11 @@ published service LayerUpdateMerger */ interface com::sun::star::lang::XInitialization ; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- } ; -//============================================================================= +//============================================================================= -} ; } ; } ; } ; } ; +} ; } ; } ; } ; } ; -#endif +#endif diff --git a/offapi/com/sun/star/configuration/backend/LdapMultiLayerStratum.idl b/offapi/com/sun/star/configuration/backend/LdapMultiLayerStratum.idl index f02bd733498e..321c9f8ae8ba 100644 --- a/offapi/com/sun/star/configuration/backend/LdapMultiLayerStratum.idl +++ b/offapi/com/sun/star/configuration/backend/LdapMultiLayerStratum.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -31,11 +31,11 @@ #include <com/sun/star/configuration/backend/MultiLayerStratum.idl> #endif -//============================================================================= +//============================================================================= module com { module sun { module star { module configuration { module backend { -//============================================================================= +//============================================================================= /** implements <type>MultiLayerStratum</type> that @@ -43,18 +43,18 @@ module com { module sun { module star { module configuration { module backend { */ service LdapMultiLayerStratum { - //------------------------------------------------------------------------- - + //------------------------------------------------------------------------- + /** provides access to multiple layers of configuration data. */ service MultiLayerStratum; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- } ; -//============================================================================= +//============================================================================= -} ; } ; } ; } ; } ; +} ; } ; } ; } ; } ; #endif diff --git a/offapi/com/sun/star/configuration/backend/LdapSingleBackend.idl b/offapi/com/sun/star/configuration/backend/LdapSingleBackend.idl index 31897515ce7c..c0a1e1931398 100644 --- a/offapi/com/sun/star/configuration/backend/LdapSingleBackend.idl +++ b/offapi/com/sun/star/configuration/backend/LdapSingleBackend.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -29,33 +29,33 @@ #ifndef __com_sun_star_configuration_backend_SingleBackend_idl__ #include <com/sun/star/configuration/backend/SingleBackend.idl> -#endif +#endif -//============================================================================= +//============================================================================= module com { module sun { module star { module configuration { module backend { -//============================================================================= +//============================================================================= /** - implements <type>SingleBackend</type> that stores data in an + implements <type>SingleBackend</type> that stores data in an LDAP directoy. - + @since OOo 1.1.2 */ published service LdapSingleBackend { - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- /** provides access to configuration data. */ service SingleBackend ; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- } ; -//============================================================================= +//============================================================================= -} ; } ; } ; } ; } ; +} ; } ; } ; } ; } ; -#endif +#endif diff --git a/offapi/com/sun/star/configuration/backend/LdapSingleStratum.idl b/offapi/com/sun/star/configuration/backend/LdapSingleStratum.idl index ae50be4c836a..e070fde5393b 100644 --- a/offapi/com/sun/star/configuration/backend/LdapSingleStratum.idl +++ b/offapi/com/sun/star/configuration/backend/LdapSingleStratum.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -31,11 +31,11 @@ #include <com/sun/star/configuration/backend/SingleLayerStratum.idl> #endif -//============================================================================= +//============================================================================= module com { module sun { module star { module configuration { module backend { -//============================================================================= +//============================================================================= /** implements <type>SingleLayerStratum</type> that @@ -43,18 +43,18 @@ module com { module sun { module star { module configuration { module backend { */ service LdapSingleStratum { - //------------------------------------------------------------------------- - + //------------------------------------------------------------------------- + /** provides access to configuration data. */ service SingleLayerStratum; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- } ; -//============================================================================= +//============================================================================= -} ; } ; } ; } ; } ; +} ; } ; } ; } ; } ; -#endif +#endif diff --git a/offapi/com/sun/star/configuration/backend/LocalDataImporter.idl b/offapi/com/sun/star/configuration/backend/LocalDataImporter.idl index 9c1dd5ee77f0..5b34c1988157 100644 --- a/offapi/com/sun/star/configuration/backend/LocalDataImporter.idl +++ b/offapi/com/sun/star/configuration/backend/LocalDataImporter.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -29,19 +29,19 @@ #ifndef __com_sun_star_configuration_backend_DataImporter_idl__ #include <com/sun/star/configuration/backend/DataImporter.idl> -#endif +#endif -//============================================================================= +//============================================================================= module com { module sun { module star { module configuration { module backend { -//============================================================================= +//============================================================================= /** - allows importing data from a local configuration data repository + allows importing data from a local configuration data repository or file into any <type>Backend</type>. - - <p> Data to be imported can be a single layer either from a full local + + <p> Data to be imported can be a single layer either from a full local configuration database or from a particular OOR Update XML file. </p> <p> Data is imported into the <type>DefaultBackend</type>. @@ -57,55 +57,55 @@ module com { module sun { module star { module configuration { module backend { */ published service LocalDataImporter { - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- /** provides for running an import job - <p> The implementation returns <void/> from + <p> The implementation returns <void/> from <member scope="com::sun::star::task">XJob::execute()</member> - to indicates successful execution. If import is not executed, - because <code>OverwriteExisting = </code><TRUE/> was specified, - a <type scope="com::sun::star::lang">IllegalAccessException</type> - is returned. + to indicates successful execution. If import is not executed, + because <code>OverwriteExisting = </code><TRUE/> was specified, + a <type scope="com::sun::star::lang">IllegalAccessException</type> + is returned. </p> - <p>If <void/> or <TRUE/> is returned, this indicates successful - execution. If an - <type scope="com::sun::star::uno">Exception</type> is returned, - it represents an error condition encountered during execution. + <p>If <void/> or <TRUE/> is returned, this indicates successful + execution. If an + <type scope="com::sun::star::uno">Exception</type> is returned, + it represents an error condition encountered during execution. </p> <p> The standard arguments to <member scope="com::sun::star::task">XJob::execute()</member> - are all supported by implementations. Additionally the following + are all supported by implementations. Additionally the following argument is required to select the data source: <dl> <dt><code>LayerDataUrl</code> : <atom >string</atom></dt> - <dd>A file URL that specifies the location of the source data. - <p> If no <code>Component</code> is provided, this must be the - location of an OOR Update XML file, which will be imported - directly. + <dd>A file URL that specifies the location of the source data. + <p> If no <code>Component</code> is provided, this must be the + location of an OOR Update XML file, which will be imported + directly. </p> - <p> If a <code>Component</code> is provided, the - <code>LayerDataUrl</code> is treated as Entity - (i.e. Layer directory base URL) for a local - configuration database and the appropriate component + <p> If a <code>Component</code> is provided, the + <code>LayerDataUrl</code> is treated as Entity + (i.e. Layer directory base URL) for a local + configuration database and the appropriate component from that repository is imported. </p> </dd> </dl> </p> - <p> Implementations may support additional parameters to select - a destination <type>Backend</type>, that is not the + <p> Implementations may support additional parameters to select + a destination <type>Backend</type>, that is not the <type>DefaultBackend</type>. </p> */ service DataImporter ; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- } ; -//============================================================================= +//============================================================================= -} ; } ; } ; } ; } ; +} ; } ; } ; } ; } ; -#endif +#endif diff --git a/offapi/com/sun/star/configuration/backend/LocalHierarchyBrowser.idl b/offapi/com/sun/star/configuration/backend/LocalHierarchyBrowser.idl index ae7244365af2..b2e5eb5e0784 100644 --- a/offapi/com/sun/star/configuration/backend/LocalHierarchyBrowser.idl +++ b/offapi/com/sun/star/configuration/backend/LocalHierarchyBrowser.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -29,52 +29,52 @@ #ifndef __com_sun_star_configuration_backend_HierarchyBrowser_idl__ #include <com/sun/star/configuration/backend/HierarchyBrowser.idl> -#endif +#endif -//============================================================================= +//============================================================================= module com { module sun { module star { module configuration { module backend { -//============================================================================= +//============================================================================= /** - is a <type>HierarchyBrowser</type>, that browses a configuration database + is a <type>HierarchyBrowser</type>, that browses a configuration database stored in the local file system. - + @see com::sun::star::configuration::backend::LocalSingleBackend @since OOo 1.1.2 */ -published service LocalHierarchyBrowser +published service LocalHierarchyBrowser { - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- - /** allows browsing a configuration hierarchy for components. + /** allows browsing a configuration hierarchy for components. - <p> Either a schema repository or a layer directory can be browsed. + <p> Either a schema repository or a layer directory can be browsed. Components can be retrieved either as component names or as file URLs. </p> <p> The following additional arguments are supported for - <member scope="com::sun::star::task">XJob::execute()</member>:<BR/> + <member scope="com::sun::star::task">XJob::execute()</member>:<BR/> <dl> <dt><code>SchemaDataUrl</code> : <atom>string</atom></dt> - <dd>Base directory to search for schema files. - If this is specified, schema files will be browsed, + <dd>Base directory to search for schema files. + If this is specified, schema files will be browsed, so argument <code>LayerDataUrl</code> should not be specified. </dd> <dt><code>LayerDataUrl</code> : <atom>string</atom></dt> - <dd>Base directory to search for layer files. - If this is specified, layer files will be browsed, + <dd>Base directory to search for layer files. + If this is specified, layer files will be browsed, so argument <code>SchemaDataUrl</code> should not be specified. </dd> <dt><code>FetchComponentNames</code> : <atom>boolean</atom></dt> <dd><ul><li>if <TRUE/> components will be returned as component names,</li> <li>if <FALSE/> components will be returned as fileURLs,</li> - <li>if this argument is not provided, the default is to - retrieve names when browsing schemas and URLs when + <li>if this argument is not provided, the default is to + retrieve names when browsing schemas and URLs when browsing layers.</li> </dd> </dl> @@ -82,11 +82,11 @@ published service LocalHierarchyBrowser */ service HierarchyBrowser ; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- } ; -//============================================================================= +//============================================================================= -} ; } ; } ; } ; } ; +} ; } ; } ; } ; } ; -#endif +#endif diff --git a/offapi/com/sun/star/configuration/backend/LocalSchemaSupplier.idl b/offapi/com/sun/star/configuration/backend/LocalSchemaSupplier.idl index 3c72d908579c..035616fa4269 100644 --- a/offapi/com/sun/star/configuration/backend/LocalSchemaSupplier.idl +++ b/offapi/com/sun/star/configuration/backend/LocalSchemaSupplier.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -29,33 +29,33 @@ #ifndef __com_sun_star_configuration_backend_SchemaSupplier_idl__ #include <com/sun/star/configuration/backend/SchemaSupplier.idl> -#endif +#endif -//============================================================================= +//============================================================================= module com { module sun { module star { module configuration { module backend { -//============================================================================= +//============================================================================= /** - implements <type>SchemaSupplier</type> providing access to + implements <type>SchemaSupplier</type> providing access to local configuration schemas */ service LocalSchemaSupplier { - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- /** provides access to configuration schemas. */ service SchemaSupplier ; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- } ; -//============================================================================= +//============================================================================= -} ; } ; } ; } ; } ; +} ; } ; } ; } ; } ; #endif diff --git a/offapi/com/sun/star/configuration/backend/LocalSingleBackend.idl b/offapi/com/sun/star/configuration/backend/LocalSingleBackend.idl index 098d8123e079..a98cc2f01762 100644 --- a/offapi/com/sun/star/configuration/backend/LocalSingleBackend.idl +++ b/offapi/com/sun/star/configuration/backend/LocalSingleBackend.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -29,33 +29,33 @@ #ifndef __com_sun_star_configuration_backend_SingleBackend_idl__ #include <com/sun/star/configuration/backend/SingleBackend.idl> -#endif +#endif -//============================================================================= +//============================================================================= module com { module sun { module star { module configuration { module backend { -//============================================================================= +//============================================================================= /** - implements <type>SingleBackend</type> that stores data in the + implements <type>SingleBackend</type> that stores data in the local filesystem using the OOR XML formats. - + @since OOo 1.1.2 */ published service LocalSingleBackend { - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- /** provides access to configuration data. */ service SingleBackend ; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- } ; -//============================================================================= +//============================================================================= -} ; } ; } ; } ; } ; +} ; } ; } ; } ; } ; -#endif +#endif diff --git a/offapi/com/sun/star/configuration/backend/LocalSingleStratum.idl b/offapi/com/sun/star/configuration/backend/LocalSingleStratum.idl index aea200df1925..8f5d06d86a57 100644 --- a/offapi/com/sun/star/configuration/backend/LocalSingleStratum.idl +++ b/offapi/com/sun/star/configuration/backend/LocalSingleStratum.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -31,11 +31,11 @@ #include <com/sun/star/configuration/backend/SingleLayerStratum.idl> #endif -//============================================================================= +//============================================================================= module com { module sun { module star { module configuration { module backend { -//============================================================================= +//============================================================================= /** implements <type>SingleLayerStratum</type> that @@ -43,18 +43,18 @@ module com { module sun { module star { module configuration { module backend { */ service LocalSingleStratum { - //------------------------------------------------------------------------- - + //------------------------------------------------------------------------- + /** provides access to configuration data. */ service SingleLayerStratum; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- } ; -//============================================================================= +//============================================================================= -} ; } ; } ; } ; } ; +} ; } ; } ; } ; } ; -#endif +#endif diff --git a/offapi/com/sun/star/configuration/backend/MalformedDataException.idl b/offapi/com/sun/star/configuration/backend/MalformedDataException.idl index 211571a41566..7eb5d4fbbf77 100644 --- a/offapi/com/sun/star/configuration/backend/MalformedDataException.idl +++ b/offapi/com/sun/star/configuration/backend/MalformedDataException.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -24,28 +24,28 @@ * for a copy of the LGPLv3 License. * ************************************************************************/ -#ifndef __com_sun_star_configuration_backend_MalformedDataException_idl__ -#define __com_sun_star_configuration_backend_MalformedDataException_idl__ - -#ifndef __com_sun_star_uno_Exception_idl__ -#include <com/sun/star/uno/Exception.idl> -#endif - -//============================================================================= +#ifndef __com_sun_star_configuration_backend_MalformedDataException_idl__ +#define __com_sun_star_configuration_backend_MalformedDataException_idl__ + +#ifndef __com_sun_star_uno_Exception_idl__ +#include <com/sun/star/uno/Exception.idl> +#endif + +//============================================================================= module com { module sun { module star { module configuration { module backend { - -//============================================================================= - + +//============================================================================= + /** is raised when the data of a component schema, layer or update is not well-formed, violates the schema or is otherwise invalid. @since OOo 1.1.2 */ published exception MalformedDataException: ::com::sun::star::uno::Exception -{ - /** - data that provides more detailed information about the +{ + /** + data that provides more detailed information about the reason and location of the error. <p> Typically this member should contain an exception characterizing @@ -78,14 +78,14 @@ published exception MalformedDataException: ::com::sun::star::uno::Exception <dd>for features that are not supported by the current implementation.</dd> </dl> </p> - <p> If no more detail information is available, this may be left <void/>. + <p> If no more detail information is available, this may be left <void/>. </p> */ - any ErrorDetails; -}; - -//============================================================================= - + any ErrorDetails; +}; + +//============================================================================= + }; }; }; }; }; - -#endif + +#endif diff --git a/offapi/com/sun/star/configuration/backend/MergeImporter.idl b/offapi/com/sun/star/configuration/backend/MergeImporter.idl index d02d68985f32..e3b75ff3a389 100644 --- a/offapi/com/sun/star/configuration/backend/MergeImporter.idl +++ b/offapi/com/sun/star/configuration/backend/MergeImporter.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -29,23 +29,23 @@ #ifndef __com_sun_star_configuration_backend_Importer_idl__ #include <com/sun/star/configuration/backend/Importer.idl> -#endif +#endif #ifndef __com_sun_star_lang_XInitialization_idl__ #include <com/sun/star/lang/XInitialization.idl> -#endif +#endif -//============================================================================= +//============================================================================= module com { module sun { module star { module configuration { module backend { -//============================================================================= +//============================================================================= -/** +/** imports data into a configuration layer by merging with existing data. - <p> No named arguments to - <member scope="com::sun::star::lang">XInitialization::initialize()</member> + <p> No named arguments to + <member scope="com::sun::star::lang">XInitialization::initialize()</member> are supported. </p> @@ -53,12 +53,12 @@ module com { module sun { module star { module configuration { module backend { */ published service MergeImporter { - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- /** allows importing configuration data into a backend. - - <p> In this implementation, the changes are merged with any - <type>XLayer</type> data that already exists in the <type>Backend</type>, + + <p> In this implementation, the changes are merged with any + <type>XLayer</type> data that already exists in the <type>Backend</type>, replacing it completely. </p> @@ -67,11 +67,11 @@ published service MergeImporter */ service Importer ; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- } ; -//============================================================================= +//============================================================================= -} ; } ; } ; } ; } ; +} ; } ; } ; } ; } ; -#endif +#endif diff --git a/offapi/com/sun/star/configuration/backend/MergeRecoveryRequest.idl b/offapi/com/sun/star/configuration/backend/MergeRecoveryRequest.idl index c5d44ac4b7bf..ef0f48f6c49f 100644 --- a/offapi/com/sun/star/configuration/backend/MergeRecoveryRequest.idl +++ b/offapi/com/sun/star/configuration/backend/MergeRecoveryRequest.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -24,28 +24,28 @@ * for a copy of the LGPLv3 License. * ************************************************************************/ -#ifndef __com_sun_star_configuration_backend_MergeRecoveryRequest_idl__ -#define __com_sun_star_configuration_backend_MergeRecoveryRequest_idl__ - -#ifndef __com_sun_star_uno_Exception_idl__ -#include <com/sun/star/uno/Exception.idl> -#endif - -//============================================================================= +#ifndef __com_sun_star_configuration_backend_MergeRecoveryRequest_idl__ +#define __com_sun_star_configuration_backend_MergeRecoveryRequest_idl__ + +#ifndef __com_sun_star_uno_Exception_idl__ +#include <com/sun/star/uno/Exception.idl> +#endif + +//============================================================================= module com { module sun { module star { module configuration { module backend { - -//============================================================================= - -/** is passed to an <type>InteractionHandler<type> when merging fails due to + +//============================================================================= + +/** is passed to an <type>InteractionHandler<type> when merging fails due to invalid layer data or access problems. @since OOo 2.0.0 */ exception MergeRecoveryRequest: ::com::sun::star::uno::Exception -{ - /** - data that provides more detailed information about the +{ + /** + data that provides more detailed information about the reason and location of the error. <p> Typically this member should contain an exception characterizing @@ -60,31 +60,31 @@ exception MergeRecoveryRequest: ::com::sun::star::uno::Exception <dd>for layers that can't be accessed.</dd> </dl> </p> - <p> If no more detail information is available, this may be left <void/>. + <p> If no more detail information is available, this may be left <void/>. </p> */ - any ErrorDetails; + any ErrorDetails; - /** + /** Identifier of the layer object containing the invalid data. */ string ErrorLayerId; - /** + /** specifies whether the requestor wants to remove or skip the invalid layer. - <p> If <TRUE/> the requestor wants to remove the underlying data of + <p> If <TRUE/> the requestor wants to remove the underlying data of the layer.<BR/> - If <FALSE/> the request is to skip the underlying data this time, + If <FALSE/> the request is to skip the underlying data this time, but without removing it. </p> */ boolean IsRemovalRequest; -}; - -//============================================================================= - +}; + +//============================================================================= + }; }; }; }; }; - -#endif + +#endif diff --git a/offapi/com/sun/star/configuration/backend/MultiLayerStratum.idl b/offapi/com/sun/star/configuration/backend/MultiLayerStratum.idl index 375f8851829c..ae92e65807fc 100644 --- a/offapi/com/sun/star/configuration/backend/MultiLayerStratum.idl +++ b/offapi/com/sun/star/configuration/backend/MultiLayerStratum.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -29,45 +29,45 @@ #ifndef __com_sun_star_configuration_backend_XBackendEntities_idl__ #include <com/sun/star/configuration/backend/XBackendEntities.idl> -#endif +#endif #ifndef __com_sun_star_configuration_backend_XMultiLayerStratum_idl__ #include <com/sun/star/configuration/backend/XMultiLayerStratum.idl> -#endif +#endif -//============================================================================= +//============================================================================= module com { module sun { module star { module configuration { module backend { -//============================================================================= +//============================================================================= /** Provides access to a singe layer of configuration data */ service MultiLayerStratum { - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- /** provides access to multiple layers of configuration data . */ interface XMultiLayerStratum ; - //------------------------------------------------------------------------- - + //------------------------------------------------------------------------- + /** provides information about supported and special entities. */ [optional] interface XBackendEntities ; + - - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- } ; -//============================================================================= +//============================================================================= -} ; } ; } ; } ; } ; +} ; } ; } ; } ; } ; #endif - + diff --git a/offapi/com/sun/star/configuration/backend/MultiStratumBackend.idl b/offapi/com/sun/star/configuration/backend/MultiStratumBackend.idl index 7e755d187d94..a8b2d9797a01 100644 --- a/offapi/com/sun/star/configuration/backend/MultiStratumBackend.idl +++ b/offapi/com/sun/star/configuration/backend/MultiStratumBackend.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite diff --git a/offapi/com/sun/star/configuration/backend/NodeAttribute.idl b/offapi/com/sun/star/configuration/backend/NodeAttribute.idl index 5c5007e5e1a2..b12950c7b0d8 100644 --- a/offapi/com/sun/star/configuration/backend/NodeAttribute.idl +++ b/offapi/com/sun/star/configuration/backend/NodeAttribute.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -24,15 +24,15 @@ * for a copy of the LGPLv3 License. * ************************************************************************/ -#ifndef __com_sun_star_configuration_backend_NodeAttribute_idl__ +#ifndef __com_sun_star_configuration_backend_NodeAttribute_idl__ #define __com_sun_star_configuration_backend_NodeAttribute_idl__ - + //============================================================================= - + module com { module sun { module star { module configuration { module backend { - + //============================================================================= - + /** These values are used to specify the behavior of a node or property in a layer. @@ -41,34 +41,34 @@ module com { module sun { module star { module configuration { module backend { </p> @see com::sun::star::configuration::backend::SchemaAttribute - During merging the values may be combined with static attributes + During merging the values may be combined with static attributes from the schema. - @since OOo 1.1.2 + @since OOo 1.1.2 */ published constants NodeAttribute -{ - //------------------------------------------------------------------------- - +{ + //------------------------------------------------------------------------- + /** indicates that a node or property may not be changed or overridden in subsequent layers */ - const short FINALIZED = 256; - - //------------------------------------------------------------------------- - + const short FINALIZED = 256; + + //------------------------------------------------------------------------- + /** indicates that a set item may not be removed or replaced - in subsequent layers. + in subsequent layers. */ - const short MANDATORY = 512; - - //------------------------------------------------------------------------- - - /** indicates that a node or property may not be changed + const short MANDATORY = 512; + + //------------------------------------------------------------------------- + + /** indicates that a node or property may not be changed in this or subsequent layer. */ - const short READONLY = 1024; - + const short READONLY = 1024; + //------------------------------------------------------------------------- /** indicates that contents shall be fused. @@ -81,21 +81,21 @@ published constants NodeAttribute @since OOo 2.0.3 */ const short FUSE = 2048; - - //------------------------------------------------------------------------- - + + //------------------------------------------------------------------------- + /** can be used to mask the node attributes from merged attributes */ const short MASK = 32512; // 0xFF00, changed to 0x7F00 because only 3 bits // are masked and fixing a bug in idlc - - //------------------------------------------------------------------------- -}; - + + //------------------------------------------------------------------------- +}; + //============================================================================= - -}; }; }; }; }; + +}; }; }; }; }; //============================================================================= - -#endif + +#endif diff --git a/offapi/com/sun/star/configuration/backend/OfflineBackend.idl b/offapi/com/sun/star/configuration/backend/OfflineBackend.idl index 57775a6a4afd..219ee23a548f 100644 --- a/offapi/com/sun/star/configuration/backend/OfflineBackend.idl +++ b/offapi/com/sun/star/configuration/backend/OfflineBackend.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -29,50 +29,50 @@ #ifndef __com_sun_star_configuration_backend_BackendAdapter_idl__ #include <com/sun/star/configuration/backend/BackendAdapter.idl> -#endif +#endif -//============================================================================= +//============================================================================= module com { module sun { module star { module configuration { module backend { -//============================================================================= +//============================================================================= /** - implements <type>BackendAdapter</type> that maintains a cache so it - can operate even if the <type>SingleBackend</type> holding the data + implements <type>BackendAdapter</type> that maintains a cache so it + can operate even if the <type>SingleBackend</type> holding the data is inaccessible. - + @see com::sun::star::configuration::backend::OnlineBackend - + @since OOo 1.1.2 */ published service OfflineBackend { - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- /** provides access to configuration data from a <type>SingleBackend</type>. - <p>If no backend is provided during initalization or if the context - contains an <code>Offline</code> flag that is <TRUE/>, then offline mode - is activated. This may fail, if the offline cache has not been filled - during a previous execution. + <p>If no backend is provided during initalization or if the context + contains an <code>Offline</code> flag that is <TRUE/>, then offline mode + is activated. This may fail, if the offline cache has not been filled + during a previous execution. </p> <p>Less entities may be available from <type>XBackendEntities</type>, - when operating in offline mode than when operating with an online + when operating in offline mode than when operating with an online <type>SingleBackend</type>. </p> - <p>If offline mode is not invoked, the implementation behaves + <p>If offline mode is not invoked, the implementation behaves like any other <type>BackendAdapter</type>. </p> */ service BackendAdapter ; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- } ; -//============================================================================= +//============================================================================= -} ; } ; } ; } ; } ; +} ; } ; } ; } ; } ; -#endif +#endif diff --git a/offapi/com/sun/star/configuration/backend/OnlineBackend.idl b/offapi/com/sun/star/configuration/backend/OnlineBackend.idl index a0d8e39abaf8..ddebe6bc5f06 100644 --- a/offapi/com/sun/star/configuration/backend/OnlineBackend.idl +++ b/offapi/com/sun/star/configuration/backend/OnlineBackend.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -29,37 +29,37 @@ #ifndef __com_sun_star_configuration_backend_BackendAdapter_idl__ #include <com/sun/star/configuration/backend/BackendAdapter.idl> -#endif +#endif -//============================================================================= +//============================================================================= module com { module sun { module star { module configuration { module backend { -//============================================================================= +//============================================================================= /** - implements a <type>BackendAdapter</type> that requires that - the <type>SingleBackend</type> holding the data + implements a <type>BackendAdapter</type> that requires that + the <type>SingleBackend</type> holding the data is continuously accessible. - + @see com::sun::star::configuration::backend::OfflineBackend - + @since OOo 1.1.2 */ published service OnlineBackend { - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- /** provides access to configuration data from a <type>SingleBackend</type>. */ service BackendAdapter ; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- } ; -//============================================================================= +//============================================================================= -} ; } ; } ; } ; } ; +} ; } ; } ; } ; } ; -#endif +#endif diff --git a/offapi/com/sun/star/configuration/backend/PlatformBackend.idl b/offapi/com/sun/star/configuration/backend/PlatformBackend.idl index 70577522da86..2fc097a78a4a 100644 --- a/offapi/com/sun/star/configuration/backend/PlatformBackend.idl +++ b/offapi/com/sun/star/configuration/backend/PlatformBackend.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -31,11 +31,11 @@ #include <com/sun/star/configuration/backend/SingleLayerStratum.idl> #endif -//============================================================================= +//============================================================================= module com { module sun { module star { module configuration { module backend { -//============================================================================= +//============================================================================= /** implements <type>SingleLayerStratum</type> that @@ -43,18 +43,18 @@ module com { module sun { module star { module configuration { module backend { */ service PlatformBackend { - //------------------------------------------------------------------------- - + //------------------------------------------------------------------------- + /** provides access to configuration data. */ service SingleLayerStratum; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- } ; -//============================================================================= +//============================================================================= -} ; } ; } ; } ; } ; +} ; } ; } ; } ; } ; #endif diff --git a/offapi/com/sun/star/configuration/backend/PropertyInfo.idl b/offapi/com/sun/star/configuration/backend/PropertyInfo.idl index 11f5fe6ba142..327934be3949 100644 --- a/offapi/com/sun/star/configuration/backend/PropertyInfo.idl +++ b/offapi/com/sun/star/configuration/backend/PropertyInfo.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -25,45 +25,45 @@ * ************************************************************************/ -#ifndef __com_sun_star_configuration_backend_PropertyInfo_idl__ -#define __com_sun_star_configuration_backend_PropertyInfo_idl__ - - -//============================================================================= - -module com { module sun { module star { module configuration { module backend { - -//============================================================================= +#ifndef __com_sun_star_configuration_backend_PropertyInfo_idl__ +#define __com_sun_star_configuration_backend_PropertyInfo_idl__ + +//============================================================================= + +module com { module sun { module star { module configuration { module backend { + +//============================================================================= + /** This structure contains all the information related to a property @see XLayerContentDescriber */ struct PropertyInfo -{ - //------------------------------------------------------------------------- +{ + //------------------------------------------------------------------------- /** The full name of the Property * for eg. org.openoffice.Inet/Settings/ooInetHTTPProxyName */ string Name; - - /** The type of the Property + + /** The type of the Property */ string Type; - /** The value of the property + /** The value of the property */ any Value; /** Is the property protected, if true the property can not - * be over written in later layer. + * be over written in later layer. */ boolean Protected; - - -}; - -//============================================================================= - -}; }; }; }; }; - + + +}; + +//============================================================================= + +}; }; }; }; }; + #endif diff --git a/offapi/com/sun/star/configuration/backend/Schema.idl b/offapi/com/sun/star/configuration/backend/Schema.idl index 873f7c464b15..55347bf17db9 100644 --- a/offapi/com/sun/star/configuration/backend/Schema.idl +++ b/offapi/com/sun/star/configuration/backend/Schema.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -39,8 +39,8 @@ module com { module sun { module star { module configuration { module backend { //============================================================================== /** - provides read only access to a configuration component schema. - + provides read only access to a configuration component schema. + <p>A component is a set of hierarchically organised and semantically related configuration settings, e.g StarWriter settings. </p> @@ -50,7 +50,7 @@ module com { module sun { module star { module configuration { module backend { </p> @see com::sun::star::configuration::backend::Layer - Service providing access to individual + Service providing access to individual configuration data for an entity. @since OOo 1.1.2 @@ -68,7 +68,7 @@ published service Schema interface XSchema ; //-------------------------------------------------------------------------- - + /** The URL of the layer data. diff --git a/offapi/com/sun/star/configuration/backend/SchemaAttribute.idl b/offapi/com/sun/star/configuration/backend/SchemaAttribute.idl index dbc58c870913..bfde6dcad6e0 100644 --- a/offapi/com/sun/star/configuration/backend/SchemaAttribute.idl +++ b/offapi/com/sun/star/configuration/backend/SchemaAttribute.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -24,57 +24,57 @@ * for a copy of the LGPLv3 License. * ************************************************************************/ -#ifndef __com_sun_star_configuration_backend_SchemaAttribute_idl__ +#ifndef __com_sun_star_configuration_backend_SchemaAttribute_idl__ #define __com_sun_star_configuration_backend_SchemaAttribute_idl__ //============================================================================= - + module com { module sun { module star { module configuration { module backend { - + //============================================================================= - + /** These values are used to specify the behavior of a node or property in the schema. @see com::sun::star::configuration::backend::NodeAttribute During merging the values may be combined with node attributes. - @since OOo 1.1.2 + @since OOo 1.1.2 */ published constants SchemaAttribute -{ - //------------------------------------------------------------------------- - - /** indicates that a property value can't be null. +{ + //------------------------------------------------------------------------- + + /** indicates that a property value can't be null. */ - const short REQUIRED = 1; - - //------------------------------------------------------------------------- - - /** indicates that the content of the node or the value of the property + const short REQUIRED = 1; + + //------------------------------------------------------------------------- + + /** indicates that the content of the node or the value of the property may depend on the locale. */ - const short LOCALIZED = 2; - - //------------------------------------------------------------------------- - + const short LOCALIZED = 2; + + //------------------------------------------------------------------------- + /** indicates that properties can be added to the node at runtime */ - const short EXTENSIBLE = 4; - - //------------------------------------------------------------------------- - + const short EXTENSIBLE = 4; + + //------------------------------------------------------------------------- + /** can be used to mask the schema attributes from merged attributes */ - const short MASK = 255; // 0x00FF - - //------------------------------------------------------------------------- -}; - + const short MASK = 255; // 0x00FF + + //------------------------------------------------------------------------- +}; + //============================================================================= - -}; }; }; }; }; + +}; }; }; }; }; //============================================================================= - -#endif + +#endif diff --git a/offapi/com/sun/star/configuration/backend/SchemaSupplier.idl b/offapi/com/sun/star/configuration/backend/SchemaSupplier.idl index 10b59ddc5c6d..667821899fcb 100644 --- a/offapi/com/sun/star/configuration/backend/SchemaSupplier.idl +++ b/offapi/com/sun/star/configuration/backend/SchemaSupplier.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -29,32 +29,32 @@ #ifndef __com_sun_star_configuration_backend_XSchemaSupplier_idl__ #include <com/sun/star/configuration/backend/XSchemaSupplier.idl> -#endif +#endif -//============================================================================= +//============================================================================= module com { module sun { module star { module configuration { module backend { -//============================================================================= +//============================================================================= /** provides access to configuration schemas */ service SchemaSupplier { - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- /** provides access to configuration schemas. */ interface XSchemaSupplier ; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- } ; -//============================================================================= +//============================================================================= -} ; } ; } ; } ; } ; +} ; } ; } ; } ; } ; -#endif +#endif diff --git a/offapi/com/sun/star/configuration/backend/SingleBackend.idl b/offapi/com/sun/star/configuration/backend/SingleBackend.idl index 2cf1dc898661..0b6b19b216dd 100644 --- a/offapi/com/sun/star/configuration/backend/SingleBackend.idl +++ b/offapi/com/sun/star/configuration/backend/SingleBackend.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -29,73 +29,73 @@ #ifndef __com_sun_star_configuration_backend_XBackendEntities_idl__ #include <com/sun/star/configuration/backend/XBackendEntities.idl> -#endif +#endif #ifndef __com_sun_star_configuration_backend_XSchemaSupplier_idl__ #include <com/sun/star/configuration/backend/XSchemaSupplier.idl> -#endif +#endif #ifndef __com_sun_star_configuration_backend_XMultiLayerStratum_idl__ #include <com/sun/star/configuration/backend/XMultiLayerStratum.idl> -#endif +#endif -//============================================================================= +//============================================================================= module com { module sun { module star { module configuration { module backend { -//============================================================================= +//============================================================================= /** - is a configuration storage backends containing a complete - configuration database, including user data, default or + is a configuration storage backends containing a complete + configuration database, including user data, default or policy layers and schemata. - <p> Configuration data is organized into layers which are selected - by components and entities. + <p> Configuration data is organized into layers which are selected + by components and entities. </p> - <p> Components are characterized by configuration schemas. - A component contains configuration data for a particular + <p> Components are characterized by configuration schemas. + A component contains configuration data for a particular application domain or software module. </p> <p> Entities are organised hierarchically in organisations, - groups, roles and individual users. Each element of the associated + groups, roles and individual users. Each element of the associated hierarchy corresponds to a layer that applies to an entity. </p> - <p> Layers contains data for multiple components + <p> Layers contains data for multiple components associated to a single entity. <p> - + @since OOo 1.1.2 */ -published service SingleBackend +published service SingleBackend { - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- /** provides access to configuration schemas. */ interface XSchemaSupplier ; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- /** provides access to the layer data. */ interface XMultiLayerStratum ; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- /** provides information about supported and special entities. */ interface XBackendEntities ; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- } ; -//============================================================================= +//============================================================================= -} ; } ; } ; } ; } ; +} ; } ; } ; } ; } ; -#endif +#endif diff --git a/offapi/com/sun/star/configuration/backend/SingleBackendAdapter.idl b/offapi/com/sun/star/configuration/backend/SingleBackendAdapter.idl index 6135f75d9f68..d2cd5b1fd2b0 100644 --- a/offapi/com/sun/star/configuration/backend/SingleBackendAdapter.idl +++ b/offapi/com/sun/star/configuration/backend/SingleBackendAdapter.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -29,37 +29,37 @@ #ifndef __com_sun_star_configuration_backend_BackendAdapter_idl__ #include <com/sun/star/configuration/backend/BackendAdapter.idl> -#endif +#endif -//============================================================================= +//============================================================================= module com { module sun { module star { module configuration { module backend { -//============================================================================= +//============================================================================= /** implements a simple <type>BackendAdapter</type> that can be used for normal configuration operation. - + <p>All real functionality is provided by the wrapped <type>SingleBackend</type>. @see com::sun::star::configuration::backend::OnlineBackend - + @since OOo 1.1.2 */ published service SingleBackendAdapter { - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- /** provides access to configuration data from a <type>SingleBackend</type>. */ service BackendAdapter ; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- } ; -//============================================================================= +//============================================================================= -} ; } ; } ; } ; } ; +} ; } ; } ; } ; } ; -#endif +#endif diff --git a/offapi/com/sun/star/configuration/backend/SingleLayerStratum.idl b/offapi/com/sun/star/configuration/backend/SingleLayerStratum.idl index 8f6a28085c7a..8cf43f94e5b3 100644 --- a/offapi/com/sun/star/configuration/backend/SingleLayerStratum.idl +++ b/offapi/com/sun/star/configuration/backend/SingleLayerStratum.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -29,45 +29,45 @@ #ifndef __com_sun_star_configuration_backend_XBackendEntities_idl__ #include <com/sun/star/configuration/backend/XBackendEntities.idl> -#endif +#endif #ifndef __com_sun_star_configuration_backend_XSingleLayerStratum_idl__ #include <com/sun/star/configuration/backend/XSingleLayerStratum.idl> -#endif +#endif -//============================================================================= +//============================================================================= module com { module sun { module star { module configuration { module backend { -//============================================================================= +//============================================================================= /** Provides access to a single layer of configuration data */ service SingleLayerStratum { - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- /** provides access to single layer of configuration data. */ interface XSingleLayerStratum ; - //------------------------------------------------------------------------- - + //------------------------------------------------------------------------- + /** provides information about supported and special entities. */ [optional] interface XBackendEntities ; + - - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- } ; -//============================================================================= +//============================================================================= -} ; } ; } ; } ; } ; +} ; } ; } ; } ; } ; #endif - + diff --git a/offapi/com/sun/star/configuration/backend/StratumCreationException.idl b/offapi/com/sun/star/configuration/backend/StratumCreationException.idl index f425118de937..507fc314cff7 100644 --- a/offapi/com/sun/star/configuration/backend/StratumCreationException.idl +++ b/offapi/com/sun/star/configuration/backend/StratumCreationException.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -24,39 +24,39 @@ * for a copy of the LGPLv3 License. * ************************************************************************/ -#ifndef __com_sun_star_configuration_backend_StratumCreationException_idl__ -#define __com_sun_star_configuration_backend_StratumCreationException_idl__ - +#ifndef __com_sun_star_configuration_backend_StratumCreationException_idl__ +#define __com_sun_star_configuration_backend_StratumCreationException_idl__ + #ifndef __com_sun_star_configuration_backend_BackendSetupException_idl__ -#include <com/sun/star/configuration/backend/BackendSetupException.idl> -#endif - -//============================================================================= +#include <com/sun/star/configuration/backend/BackendSetupException.idl> +#endif + +//============================================================================= module com { module sun { module star { module configuration { module backend { - -//============================================================================= - + +//============================================================================= + /** is passed to an <type>InteractionHandler<type> when creating a stratum backend fails. @since OOo 2.0.0 */ exception StratumCreationException : BackendSetupException -{ - /** +{ + /** Identifier of the stratum service that could not be created. */ string StratumService; - /** + /** Initialization data passed to the stratum instance. */ string StratumData; -}; - -//============================================================================= - +}; + +//============================================================================= + }; }; }; }; }; - -#endif + +#endif diff --git a/offapi/com/sun/star/configuration/backend/SystemIntegration.idl b/offapi/com/sun/star/configuration/backend/SystemIntegration.idl index 5aa281a67ec0..1154bd44025e 100644 --- a/offapi/com/sun/star/configuration/backend/SystemIntegration.idl +++ b/offapi/com/sun/star/configuration/backend/SystemIntegration.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -29,44 +29,44 @@ #ifndef __com_sun_star_configuration_backend_Backend_idl__ #include <com/sun/star/configuration/backend/Backend.idl> -#endif +#endif #ifndef __com_sun_star_lang_XInitialization_idl__ #include <com/sun/star/lang/XInitialization.idl> -#endif -//============================================================================= +#endif +//============================================================================= module com { module sun { module star { module configuration { module backend { -//============================================================================= +//============================================================================= -/** - provides access to a configuration data composed of one or more +/** + provides access to a configuration data composed of one or more platform backends containing settings used by software modules. - + */ service SystemIntegration { - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- /** provides access to the layer data. */ - interface XBackend ; - + interface XBackend ; + /** allows initialization of backend data sources - - <p>no parameters need to be passed as backends are initialised + + <p>no parameters need to be passed as backends are initialised using the service registration database 'services.rdb'. - </p> - + </p> + */ interface com::sun::star::lang::XInitialization ; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- } ; -//============================================================================= +//============================================================================= -} ; } ; } ; } ; } ; -#endif +} ; } ; } ; } ; } ; +#endif diff --git a/offapi/com/sun/star/configuration/backend/TemplateIdentifier.idl b/offapi/com/sun/star/configuration/backend/TemplateIdentifier.idl index b0338b771e41..cf549f4f6bf3 100644 --- a/offapi/com/sun/star/configuration/backend/TemplateIdentifier.idl +++ b/offapi/com/sun/star/configuration/backend/TemplateIdentifier.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -24,44 +24,44 @@ * for a copy of the LGPLv3 License. * ************************************************************************/ -#ifndef __com_sun_star_configuration_backend_TemplateIdentifier_idl__ +#ifndef __com_sun_star_configuration_backend_TemplateIdentifier_idl__ #define __com_sun_star_configuration_backend_TemplateIdentifier_idl__ - - + + //============================================================================= - + module com { module sun { module star { module configuration { module backend { - -//============================================================================= - + +//============================================================================= + /** holds the data needed to identify a template. - @since OOo 1.1.2 - + @since OOo 1.1.2 + */ published struct TemplateIdentifier { /** specifies the name of the template. - + <p>The name is unique within a component.</p> */ - string Name; - - //------------------------------------------------------------------------- - + string Name; + + //------------------------------------------------------------------------- + /** specifies the component where the template originates. - + */ - string Component; - - //------------------------------------------------------------------------- - -}; - -//============================================================================= - -}; }; }; }; }; - -//============================================================================= - -#endif + string Component; + + //------------------------------------------------------------------------- + +}; + +//============================================================================= + +}; }; }; }; }; + +//============================================================================= + +#endif diff --git a/offapi/com/sun/star/configuration/backend/UpdatableLayer.idl b/offapi/com/sun/star/configuration/backend/UpdatableLayer.idl index f74b1f2d5ce8..312280e3665c 100644 --- a/offapi/com/sun/star/configuration/backend/UpdatableLayer.idl +++ b/offapi/com/sun/star/configuration/backend/UpdatableLayer.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -52,19 +52,19 @@ module com { module sun { module star { module configuration { module backend { <p>An updatable layer can be read or replaced with another layer. </p> - @since OOo 1.1.2 + @since OOo 1.1.2 */ published service UpdatableLayer { //-------------------------------------------------------------------------- /** - handles read access to the contents of the layer. + handles read access to the contents of the layer. - <p> If the implementation supports + <p> If the implementation supports <type scope="com::sun::star::util">XTimeStamped</type>, then after executing <member>XUpdatableLayer::replaceWith()</member> - the timestamp will be the one for the replaced contents and + the timestamp will be the one for the replaced contents and if reading after updates is supported the next read will reproduce the replaced data. </p> @@ -74,19 +74,19 @@ published service UpdatableLayer //-------------------------------------------------------------------------- /** - provides write access to the contents of the layer. - - <p> Depending of the actual type (simple, i.e pure <type>XLayer</type> or - composite, i.e <type>XCompositeLayer</type>) of the current layer and - the provided replacement layer, the operation performed + provides write access to the contents of the layer. + + <p> Depending of the actual type (simple, i.e pure <type>XLayer</type> or + composite, i.e <type>XCompositeLayer</type>) of the current layer and + the provided replacement layer, the operation performed by <member>XUpdatableLayer::replaceWith()</member>, will vary. </p> <p> For the different current/replacement layer combinations, we have: <dl> - <dt>Simple/Simple<dt> + <dt>Simple/Simple<dt> <dd>the provided layer's contents replace the current one's.</dd> - <dt>Composite/Composite<dt> + <dt>Composite/Composite<dt> <dd>all layers (main and sub) present in the provided layer are used to replace the corresponding current layer contents. Sublayers present in the current layer but @@ -95,12 +95,12 @@ published service UpdatableLayer the current layer. </dd> - <dt>Simple/Composite<dt> - <dd>the main layer and sublayers of the provided layer - are merged into one whose contents replace the current layer. + <dt>Simple/Composite<dt> + <dd>the main layer and sublayers of the provided layer + are merged into one whose contents replace the current layer. </dd> - <dt>Composite/Simple<dt> + <dt>Composite/Simple<dt> <dd>the provided layer is split into a composite one whose contents are then used to replace the current layer as described above. </dd> @@ -110,7 +110,7 @@ published service UpdatableLayer support conversions of the replacement layer. In such a case the sublayers of the provided layer may be ignored or all simple data be merged into the main layer. - </em> + </em> </p> */ interface XUpdatableLayer ; diff --git a/offapi/com/sun/star/configuration/backend/XBackend.idl b/offapi/com/sun/star/configuration/backend/XBackend.idl index 5696bff294b3..02a4b4ee750c 100644 --- a/offapi/com/sun/star/configuration/backend/XBackend.idl +++ b/offapi/com/sun/star/configuration/backend/XBackend.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -29,23 +29,23 @@ #ifndef __com_sun_star_uno_XInterface_idl__ #include <com/sun/star/uno/XInterface.idl> -#endif +#endif #ifndef __com_sun_star_configuration_backend_XUpdateHandler_idl__ #include <com/sun/star/configuration/backend/XUpdateHandler.idl> -#endif +#endif #ifndef __com_sun_star_configuration_backend_XLayer_idl__ #include <com/sun/star/configuration/backend/XLayer.idl> -#endif +#endif #ifndef __com_sun_star_configuration_backend_XSchema_idl__ #include <com/sun/star/configuration/backend/XSchema.idl> -#endif +#endif #ifndef __com_sun_star_configuration_backend_BackendAccessException_idl__ #include <com/sun/star/configuration/backend/BackendAccessException.idl> -#endif +#endif #ifndef __com_sun_star_lang_IllegalArgumentException_idl__ #include <com/sun/star/lang/IllegalArgumentException.idl> @@ -53,13 +53,13 @@ #ifndef __com_sun_star_lang_NoSupportException_idl__ #include <com/sun/star/lang/NoSupportException.idl> -#endif +#endif -//============================================================================= +//============================================================================= module com { module sun { module star { module configuration { module backend { -//============================================================================= +//============================================================================= /** Handles access to layered data stored in a repository. @@ -67,28 +67,28 @@ module com { module sun { module star { module configuration { module backend { <p> Data can be retrieved on behalf of one or more entities.</p> <p> There is an implied owner entity associated to the object - when it is created. This entity should be used for normal data access. - For administrative operations data of other entities can be accessed. + when it is created. This entity should be used for normal data access. + For administrative operations data of other entities can be accessed. </p> @see com::sun::star::configuration::backend::XBackendEntities @see com::sun::star::configuration::backend::XSchemaSupplier - + @since OOo 1.1.2 */ -published interface XBackend : ::com::sun::star::uno::XInterface +published interface XBackend : ::com::sun::star::uno::XInterface { - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- - /** - retrieves the layers associated to the owner + /** + retrieves the layers associated to the owner entity for a component. - @param aComponent + @param aComponent component whose data will be accessed - @returns - a list of objects allowing access to the + @returns + a list of objects allowing access to the component data for each layer associated to the current entity @@ -97,24 +97,24 @@ published interface XBackend : ::com::sun::star::uno::XInterface @throws com::sun::star::configuration::backend::BackendAccessException if an error occurs while accessing the data. - + @see com::sun::star::configuration::backend::XBackendEntities::getOwnerEntity() */ sequence<XLayer> listOwnLayers([in] string aComponent) raises (BackendAccessException, com::sun::star::lang::IllegalArgumentException) ; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- - /** - creates an update handler for the owner entity + /** + creates an update handler for the owner entity layer for a component. - @param aComponent + @param aComponent component whose data will be updated - @returns - an object allowing manipulation of the + @returns + an object allowing manipulation of the component data for the current entity @throws com::sun::star::lang::IllegalArgumentException @@ -133,20 +133,20 @@ published interface XBackend : ::com::sun::star::uno::XInterface com::sun::star::lang::NoSupportException, com::sun::star::lang::IllegalArgumentException) ; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- - /** + /** retrieves the layers associated to an entity for a component. - @param aComponent + @param aComponent component whose data will be accessed - @param aEntity + @param aEntity entity whose data will be accessed - @returns - a list of objects allowing access to the - component data for each layer associated + @returns + a list of objects allowing access to the + component data for each layer associated with the entity. @throws com::sun::star::lang::IllegalArgumentException @@ -163,19 +163,19 @@ published interface XBackend : ::com::sun::star::uno::XInterface raises (BackendAccessException, com::sun::star::lang::IllegalArgumentException) ; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- /** creates an update handler on an entity's layer for a component. - @param aComponent + @param aComponent component whose data will be updated - @param aEntity + @param aEntity entity whose data will be updated - @returns - an object allowing manipulation of the + @returns + an object allowing manipulation of the component data for the entity @throws com::sun::star::lang::IllegalArgumentException @@ -190,17 +190,17 @@ published interface XBackend : ::com::sun::star::uno::XInterface @see com::sun::star::configuration::backend::XBackendEntities::supportsEntity() */ - XUpdateHandler getUpdateHandler([in] string aComponent, + XUpdateHandler getUpdateHandler([in] string aComponent, [in] string aEntity) raises (BackendAccessException, com::sun::star::lang::NoSupportException, com::sun::star::lang::IllegalArgumentException) ; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- } ; -//============================================================================= +//============================================================================= -} ; } ; } ; } ; } ; +} ; } ; } ; } ; } ; -#endif +#endif diff --git a/offapi/com/sun/star/configuration/backend/XBackendChangesListener.idl b/offapi/com/sun/star/configuration/backend/XBackendChangesListener.idl index 6530e7182fea..aa41d2905450 100644 --- a/offapi/com/sun/star/configuration/backend/XBackendChangesListener.idl +++ b/offapi/com/sun/star/configuration/backend/XBackendChangesListener.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -25,41 +25,41 @@ * ************************************************************************/ -#ifndef __com_sun_star_configuration_backend_XBackendChangesListener_idl__ -#define __com_sun_star_configuration_backend_XBackendChangesListener_idl__ +#ifndef __com_sun_star_configuration_backend_XBackendChangesListener_idl__ +#define __com_sun_star_configuration_backend_XBackendChangesListener_idl__ -#ifndef __com_sun_star_configuration_backend_ComponentChangeEvent_idl__ +#ifndef __com_sun_star_configuration_backend_ComponentChangeEvent_idl__ #include <com/sun/star/configuration/backend/ComponentChangeEvent.idl> #endif -#ifndef __com_sun_star_lang_XEventListener_idl__ -#include <com/sun/star/lang/XEventListener.idl> -#endif -//============================================================================= - -module com { module sun { module star { module configuration { module backend { - -//============================================================================= - +#ifndef __com_sun_star_lang_XEventListener_idl__ +#include <com/sun/star/lang/XEventListener.idl> +#endif +//============================================================================= + +module com { module sun { module star { module configuration { module backend { + +//============================================================================= + /** receives notification from backend broadcaster objects. - @see XBackendChangesNotifier - + @see XBackendChangesNotifier + */ interface XBackendChangesListener: ::com::sun::star::lang::XEventListener -{ - //------------------------------------------------------------------------- +{ + //------------------------------------------------------------------------- /** is invoked when component data in backend source changes - + @param Event Event indicating the component data change */ - void componentDataChanged( [in] com::sun::star::configuration::backend::ComponentChangeEvent Event ); - -}; - -//============================================================================= - -}; }; }; }; }; - -#endif + void componentDataChanged( [in] com::sun::star::configuration::backend::ComponentChangeEvent Event ); + +}; + +//============================================================================= + +}; }; }; }; }; + +#endif diff --git a/offapi/com/sun/star/configuration/backend/XBackendChangesNotifier.idl b/offapi/com/sun/star/configuration/backend/XBackendChangesNotifier.idl index ca2861bcf443..82d36983654c 100644 --- a/offapi/com/sun/star/configuration/backend/XBackendChangesNotifier.idl +++ b/offapi/com/sun/star/configuration/backend/XBackendChangesNotifier.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -24,57 +24,57 @@ * for a copy of the LGPLv3 License. * ************************************************************************/ -#ifndef __com_sun_star_configuration_backend_XBackendChangesNotifier_idl__ -#define __com_sun_star_configuration_backend_XBackendChangesNotifier_idl__ - -#ifndef __com_sun_star_configuration_backend_XBackendChangesListener_idl__ -#include <com/sun/star/configuration/backend/XBackendChangesListener.idl> +#ifndef __com_sun_star_configuration_backend_XBackendChangesNotifier_idl__ +#define __com_sun_star_configuration_backend_XBackendChangesNotifier_idl__ + +#ifndef __com_sun_star_configuration_backend_XBackendChangesListener_idl__ +#include <com/sun/star/configuration/backend/XBackendChangesListener.idl> #endif #ifndef __com_sun_star_uno_XInterface_idl__ #include <com/sun/star/uno/XInterface.idl> -#endif - -//============================================================================= - -module com { module sun { module star { module configuration { module backend { - -//============================================================================= - +#endif + +//============================================================================= + +module com { module sun { module star { module configuration { module backend { + +//============================================================================= + /** broadcasts changes when data from backend sources has changed. - @see XBackendChangesListener + @see XBackendChangesListener */ interface XBackendChangesNotifier: com::sun::star::uno::XInterface -{ - //------------------------------------------------------------------------- +{ + //------------------------------------------------------------------------- /** adds the specified listener to receive events when changes occured. @param aListener specifies the listener object. @param component The name of the component the listener is monitoring changes for. - + */ [oneway] void addChangesListener( [in] com::sun::star::configuration::backend::XBackendChangesListener aListener, - [in] string component); - - //------------------------------------------------------------------------- + [in] string component); + + //------------------------------------------------------------------------- /** removes the specified listener. @param aListener specifies the listener object. @param component The name of the component the listener is monitoring changes for. - + */ [oneway] void removeChangesListener( [in] com::sun::star::configuration::backend::XBackendChangesListener aListener, - [in] string component); - -}; - -//============================================================================= - -}; }; }; }; }; - -#endif + [in] string component); + +}; + +//============================================================================= + +}; }; }; }; }; + +#endif diff --git a/offapi/com/sun/star/configuration/backend/XBackendEntities.idl b/offapi/com/sun/star/configuration/backend/XBackendEntities.idl index 9829ad993ec3..3855281fb8a9 100644 --- a/offapi/com/sun/star/configuration/backend/XBackendEntities.idl +++ b/offapi/com/sun/star/configuration/backend/XBackendEntities.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -29,42 +29,42 @@ #ifndef __com_sun_star_uno_XInterface_idl__ #include <com/sun/star/uno/XInterface.idl> -#endif +#endif #ifndef __com_sun_star_lang_IllegalArgumentException_idl__ #include <com/sun/star/lang/IllegalArgumentException.idl> -#endif +#endif #ifndef __com_sun_star_configuration_backend_BackendAccessException_idl__ #include <com/sun/star/configuration/backend/BackendAccessException.idl> -#endif +#endif -//============================================================================= +//============================================================================= module com { module sun { module star { module configuration { module backend { -//============================================================================= - -/** - Provides functionality relating to common and supported entities - for a configuration data backend. +//============================================================================= +/** + Provides functionality relating to common and supported entities + for a configuration data backend. + @see com::sun::star::configuration::backend::XBackend @see com::sun::star::configuration::backend::XMultiLayerStratum @since OOo 1.1.2 */ -published interface XBackendEntities : ::com::sun::star::uno::XInterface +published interface XBackendEntities : ::com::sun::star::uno::XInterface { - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- - /** + /** provides the entity id of the owner entity of the backend. - @returns + @returns an entity identifier for the owner entity. - <p> The owner entity is the default entity for the backend. - For normal configuration data access the owner entity - should always be used. + <p> The owner entity is the default entity for the backend. + For normal configuration data access the owner entity + should always be used. </p> @see com::sun::star::configuration::backend::XBackend::listOwnLayers() @@ -72,71 +72,71 @@ published interface XBackendEntities : ::com::sun::star::uno::XInterface */ string getOwnerEntity() ; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- - /** + /** provides the entity id of an entity for general administrative access. - <p> The admin entity is an entity that should be used to - read and manage configuration data that applies to all entities - within the backend. + <p> The admin entity is an entity that should be used to + read and manage configuration data that applies to all entities + within the backend. </p> - @returns - an entity identifier for the admin entity or - an empty string, if there is no entity that can be used for + @returns + an entity identifier for the admin entity or + an empty string, if there is no entity that can be used for general administrative access. */ string getAdminEntity() ; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- - /** + /** determines, if a given entity id exists in this backend. - - @param aEntity - The name of an entity. + + @param aEntity + The name of an entity. @throws com::sun::star::configuration::backend::BackendAccessException if an error occurs while accessing the backend. - - @returns - <TRUE/>, if aEntity is a valid, existing entity for this backend, + + @returns + <TRUE/>, if aEntity is a valid, existing entity for this backend, <FALSE/> otherwise. */ - boolean supportsEntity([in] string aEntity) + boolean supportsEntity([in] string aEntity) raises( BackendAccessException ); - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- - /** + /** determines, if two given entity ids denote the same entity. - @param aEntity - The name of an entity. + @param aEntity + The name of an entity. - @param aOtherEntity - The name of another entity. + @param aOtherEntity + The name of another entity. - @returns - <TRUE/>, if aEntity and aOtherEntity denote the same entity + @returns + <TRUE/>, if aEntity and aOtherEntity denote the same entity within this backend, <FALSE/> otherwise. @throws com::sun::star::configuration::backend::BackendAccessException if an error occurs while accessing the backend. - + @throws com::sun::star::lang::IllegalArgumentException if either entity does not exist. */ - boolean isEqualEntity([in] string aEntity, [in] string aOtherEntity) + boolean isEqualEntity([in] string aEntity, [in] string aOtherEntity) raises( BackendAccessException, com::sun::star::lang::IllegalArgumentException) ; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- } ; -//============================================================================= +//============================================================================= } ; } ; } ; } ; } ; -#endif +#endif diff --git a/offapi/com/sun/star/configuration/backend/XCompositeLayer.idl b/offapi/com/sun/star/configuration/backend/XCompositeLayer.idl index 74dc11e27820..255f91701da9 100644 --- a/offapi/com/sun/star/configuration/backend/XCompositeLayer.idl +++ b/offapi/com/sun/star/configuration/backend/XCompositeLayer.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -34,7 +34,7 @@ #ifndef __com_sun_star_lang_NullPointerException_idl__ #include <com/sun/star/lang/NullPointerException.idl> -#endif +#endif #ifndef __com_sun_star_lang_IllegalArgumentException_idl__ #include <com/sun/star/lang/IllegalArgumentException.idl> @@ -55,39 +55,39 @@ module com { module sun { module star { module configuration { module backend { //============================================================================== /** - provides read access to layers that contain sublayers accessible through an + provides read access to layers that contain sublayers accessible through an additional criterion (for instance the locale they contain data for). @since OOo 1.1.2 */ -published interface XCompositeLayer : XLayer +published interface XCompositeLayer : XLayer { //-------------------------------------------------------------------------- - + /** Returns a list of the criteria that can be used to access the sublayers. - @return + @return a list supported sublayer identifiers @throws com::sun::star::lang::WrappedTargetException if an error occurs in the retrieval of the data. */ - sequence<string> listSubLayerIds() + sequence<string> listSubLayerIds() raises (com::sun::star::lang::WrappedTargetException) ; - + //-------------------------------------------------------------------------- - + /** Describes the content of a particular sublayer to an <type>XLayerHandler</type>. - @param aHandler - Handler object that will receive calls + @param aHandler + Handler object that will receive calls describing the contents of the sublayer. - @param aSubLayerId + @param aSubLayerId Identifier of the sublayer to be read. <p> Must be one the identifiers returned by <member>XCompositeLayer::listSubLayerIds()</member> @@ -103,7 +103,7 @@ published interface XCompositeLayer : XLayer if the data read from the layer is rejected as invalid by the <type>XLayerHandler</type>. */ - void readSubLayerData([in] XLayerHandler aHandler, [in] string aSubLayerId) + void readSubLayerData([in] XLayerHandler aHandler, [in] string aSubLayerId) raises (com::sun::star::lang::NullPointerException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException, @@ -115,4 +115,4 @@ published interface XCompositeLayer : XLayer //============================================================================== } ; } ; } ; } ; } ; -#endif +#endif diff --git a/offapi/com/sun/star/configuration/backend/XLayer.idl b/offapi/com/sun/star/configuration/backend/XLayer.idl index 89911d869dc8..55ee830f7eda 100644 --- a/offapi/com/sun/star/configuration/backend/XLayer.idl +++ b/offapi/com/sun/star/configuration/backend/XLayer.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -29,44 +29,44 @@ #ifndef __com_sun_star_uno_XInterface_idl__ #include <com/sun/star/uno/XInterface.idl> -#endif +#endif #ifndef __com_sun_star_configuration_backend_XLayerHandler_idl__ #include <com/sun/star/configuration/backend/XLayerHandler.idl> -#endif +#endif #ifndef __com_sun_star_lang_NullPointerException_idl__ #include <com/sun/star/lang/NullPointerException.idl> -#endif +#endif #ifndef __com_sun_star_lang_WrappedTargetException_idl__ #include <com/sun/star/lang/WrappedTargetException.idl> -#endif +#endif #ifndef __com_sun_star_configuration_backend_MalformedDataException_idl__ #include <com/sun/star/configuration/backend/MalformedDataException.idl> #endif -//============================================================================= +//============================================================================= module com { module sun { module star { module configuration { module backend { -//============================================================================= +//============================================================================= -/** +/** provides read access to the data contained in a layer. @since OOo 1.1.2 */ -published interface XLayer : ::com::sun::star::uno::XInterface +published interface XLayer : ::com::sun::star::uno::XInterface { - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- - /** + /** describes the contents of the layer to an <type>XLayerHandler</type>. - @param aHandler - Handler object that will receive calls + @param aHandler + Handler object that will receive calls describing the contents of the layer @throws com::sun::star::lang::NullPointerException @@ -77,15 +77,15 @@ published interface XLayer : ::com::sun::star::uno::XInterface if the data read from the layer is rejected as invalid by the <type>XLayerHandler</type>. */ - void readData([in] XLayerHandler aHandler) + void readData([in] XLayerHandler aHandler) raises (com::sun::star::lang::NullPointerException, com::sun::star::lang::WrappedTargetException, MalformedDataException) ; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- } ; -//============================================================================= +//============================================================================= -} ; } ; } ; } ; } ; -#endif +} ; } ; } ; } ; } ; +#endif diff --git a/offapi/com/sun/star/configuration/backend/XLayerContentDescriber.idl b/offapi/com/sun/star/configuration/backend/XLayerContentDescriber.idl index d8718f361c1a..f477d41a533b 100644 --- a/offapi/com/sun/star/configuration/backend/XLayerContentDescriber.idl +++ b/offapi/com/sun/star/configuration/backend/XLayerContentDescriber.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -27,51 +27,51 @@ #ifndef __com_sun_star_configuration_backend_XLayerContentDescriber_idl__ #define __com_sun_star_configuration_backend_XLayerContentDescriber_idl__ -#ifndef __com_sun_star_configuration_backend_PropertyInfo_idl__ +#ifndef __com_sun_star_configuration_backend_PropertyInfo_idl__ #include <com/sun/star/configuration/backend/PropertyInfo.idl> #endif #ifndef __com_sun_star_uno_XInterface_idl__ #include <com/sun/star/uno/XInterface.idl> -#endif +#endif #ifndef __com_sun_star_configuration_backend_XLayerHandler_idl__ #include <com/sun/star/configuration/backend/XLayerHandler.idl> -#endif +#endif #ifndef __com_sun_star_lang_NullPointerException_idl__ #include <com/sun/star/lang/NullPointerException.idl> -#endif +#endif #ifndef __com_sun_star_configuration_backend_MalformedDataException_idl__ #include <com/sun/star/configuration/backend/MalformedDataException.idl> #endif -//============================================================================= +//============================================================================= module com { module sun { module star { module configuration { module backend { -//============================================================================= +//============================================================================= -/** +/** describe the contents of a layer to an XLayerHander object. The contents of the layer is contained in the sequence of PropertyInfo structures @see PropertyInfo - + */ -interface XLayerContentDescriber : ::com::sun::star::uno::XInterface +interface XLayerContentDescriber : ::com::sun::star::uno::XInterface { - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- - /** + /** describes the contents of the layer to an <type>XLayerHandler</type>. - @param aHandler - Handler object that will receive calls + @param aHandler + Handler object that will receive calls describing the contents of the layer @param aPropertyInfos - sequence of PropertyInfo structs contained + sequence of PropertyInfo structs contained all required property information @throws com::sun::star::lang::NullPointerException @@ -81,15 +81,15 @@ interface XLayerContentDescriber : ::com::sun::star::uno::XInterface <type>XLayerHandler</type>. */ void describeLayer([in] XLayerHandler aHandler, - [in] sequence<PropertyInfo> aPropertyInfos) + [in] sequence<PropertyInfo> aPropertyInfos) raises (com::sun::star::lang::NullPointerException, com::sun::star::lang::WrappedTargetException, MalformedDataException) ; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- } ; -//============================================================================= +//============================================================================= -} ; } ; } ; } ; } ; +} ; } ; } ; } ; } ; #endif diff --git a/offapi/com/sun/star/configuration/backend/XLayerHandler.idl b/offapi/com/sun/star/configuration/backend/XLayerHandler.idl index 22b75c9466dc..c2579b272efa 100644 --- a/offapi/com/sun/star/configuration/backend/XLayerHandler.idl +++ b/offapi/com/sun/star/configuration/backend/XLayerHandler.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -24,40 +24,40 @@ * for a copy of the LGPLv3 License. * ************************************************************************/ -#ifndef __com_sun_star_configuration_backend_XLayerHandler_idl__ +#ifndef __com_sun_star_configuration_backend_XLayerHandler_idl__ #define __com_sun_star_configuration_backend_XLayerHandler_idl__ - -#ifndef __com_sun_star_uno_XInterface_idl__ -#include <com/sun/star/uno/XInterface.idl> -#endif - -#ifndef __com_sun_star_configuration_backend_TemplateIdentifier_idl__ -#include <com/sun/star/configuration/backend/TemplateIdentifier.idl> -#endif - -#ifndef __com_sun_star_configuration_backend_MalformedDataException_idl__ -#include <com/sun/star/configuration/backend/MalformedDataException.idl> -#endif - -#ifndef __com_sun_star_lang_WrappedTargetException_idl__ -#include <com/sun/star/lang/WrappedTargetException.idl> -#endif + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_configuration_backend_TemplateIdentifier_idl__ +#include <com/sun/star/configuration/backend/TemplateIdentifier.idl> +#endif + +#ifndef __com_sun_star_configuration_backend_MalformedDataException_idl__ +#include <com/sun/star/configuration/backend/MalformedDataException.idl> +#endif + +#ifndef __com_sun_star_lang_WrappedTargetException_idl__ +#include <com/sun/star/lang/WrappedTargetException.idl> +#endif //============================================================================= - + module com { module sun { module star { module configuration { module backend { - -//============================================================================= - -/** receives a description of a configuration layer + +//============================================================================= + +/** receives a description of a configuration layer as a sequence of events. @since OOo 1.1.2 */ published interface XLayerHandler: ::com::sun::star::uno::XInterface -{ - //------------------------------------------------------------------------- - +{ + //------------------------------------------------------------------------- + /** receives notification that a layer description is started for a component. @@ -72,11 +72,11 @@ published interface XLayerHandler: ::com::sun::star::uno::XInterface @throws com::sun::star::lang::WrappedTargetException if an error occurs processing the event. */ - void startLayer( ) + void startLayer( ) raises( MalformedDataException, - com::sun::star::lang::WrappedTargetException ); - //------------------------------------------------------------------------- - + com::sun::star::lang::WrappedTargetException ); + //------------------------------------------------------------------------- + /** receives notification that a layer description is complete. <p> Must match a previous call to <member>XLayerHandler::startLayer()</member>. @@ -86,7 +86,7 @@ published interface XLayerHandler: ::com::sun::star::uno::XInterface <ul> <li>if invalid data is detected in the layer</li> <li>if there is a unfinished subnode in progress</li> - <li>if no layer is started at all</li> + <li>if no layer is started at all</li> <li>if the layer tries to override read-only or final data</li> </ul> <p><em>Not every implementation can detect each condition</em></p> @@ -94,15 +94,15 @@ published interface XLayerHandler: ::com::sun::star::uno::XInterface @throws com::sun::star::lang::WrappedTargetException if an error occurs processing the event. */ - void endLayer( ) + void endLayer( ) raises( MalformedDataException, - com::sun::star::lang::WrappedTargetException ); - //------------------------------------------------------------------------- - + com::sun::star::lang::WrappedTargetException ); + //------------------------------------------------------------------------- + /** receives notification that a description of a node override is started. - <p> Subsequent calls describe overrides to properties and members - or items of the node until a matching call to + <p> Subsequent calls describe overrides to properties and members + or items of the node until a matching call to <member>XLayerHandler::endNode()</member>is encountered. </p> @@ -112,15 +112,15 @@ published interface XLayerHandler: ::com::sun::star::uno::XInterface @param aAttributes specifies attribute values to be applied to the node. - <p> The value is a combination of + <p> The value is a combination of <type>NodeAttribute</type> flags. </p> - <p> The attributes are combined cumulatively with those + <p> The attributes are combined cumulatively with those set on lower layers. </p> @param bClear - if <TRUE/>, specifies that the node should be cleared to an empty + if <TRUE/>, specifies that the node should be cleared to an empty state by removing all non-mandatory children from lower layers prior to applying the overrides. @@ -141,23 +141,23 @@ published interface XLayerHandler: ::com::sun::star::uno::XInterface @see com::sun::star::configuration::backend::NodeAttribute */ void overrideNode( [in] string aName, - [in] short aAttributes, - [in] boolean bClear ) + [in] short aAttributes, + [in] boolean bClear ) raises( MalformedDataException, - com::sun::star::lang::WrappedTargetException ); - //------------------------------------------------------------------------- - + com::sun::star::lang::WrappedTargetException ); + //------------------------------------------------------------------------- + /** receives notification that a new item is started. - <p> The current node must be a set and + <p> The current node must be a set and a preexisting item (if any) must be removeable. </p> <p> The new item will be created from the default template of the set. </p> <p> Subsequent calls describe the difference from the template - of properties and members or items of the node until - a matching call to <member>XLayerHandler::endNode()</member> + of properties and members or items of the node until + a matching call to <member>XLayerHandler::endNode()</member> is encountered. </p> @@ -167,7 +167,7 @@ published interface XLayerHandler: ::com::sun::star::uno::XInterface @param aAttributes specifies attribute values to be applied to the new node. - <p> The value is a combination of + <p> The value is a combination of <type>NodeAttribute</type> flags. Note that <member>NodeAttribute::FUSE</member> has an impact on the semantics of this method. @@ -179,7 +179,7 @@ published interface XLayerHandler: ::com::sun::star::uno::XInterface <li>if there already was a change to a node of that name</li> <li>if the template for the new node is not found</li> <li>if an item of that name on a lower layer is not removeable</li> - <li>if the name is not a valid item name</li> + <li>if the name is not a valid item name</li> <li>if the attributes are not valid for the node</li> </ul> <p><em>Not every implementation can detect each condition</em></p> @@ -189,21 +189,21 @@ published interface XLayerHandler: ::com::sun::star::uno::XInterface @see com::sun::star::configuration::backend::NodeAttribute */ - void addOrReplaceNode( [in] string aName, - [in] short aAttributes ) + void addOrReplaceNode( [in] string aName, + [in] short aAttributes ) raises( MalformedDataException, - com::sun::star::lang::WrappedTargetException ); - //------------------------------------------------------------------------- - - /** receives notification that a new item based on a particular template + com::sun::star::lang::WrappedTargetException ); + //------------------------------------------------------------------------- + + /** receives notification that a new item based on a particular template is started. - <p> The current node must be a set and + <p> The current node must be a set and a preexisting item (if any) must be removeable. </p> <p> Subsequent calls describe the difference from the template - of properties and members or items of the node until - a matching call to <member>XLayerHandler::endNode()</member> + of properties and members or items of the node until + a matching call to <member>XLayerHandler::endNode()</member> is encountered. </p> @@ -216,7 +216,7 @@ published interface XLayerHandler: ::com::sun::star::uno::XInterface @param aAttributes specifies attribute values to be applied to the new node. - <p> The value is a combination of + <p> The value is a combination of <type>NodeAttribute</type> flags. Note that <member>NodeAttribute::FUSE</member> has an impact on the semantics of this method. @@ -239,17 +239,17 @@ published interface XLayerHandler: ::com::sun::star::uno::XInterface @see com::sun::star::configuration::backend::NodeAttribute */ - void addOrReplaceNodeFromTemplate( [in] string aName, + void addOrReplaceNodeFromTemplate( [in] string aName, [in] TemplateIdentifier aTemplate, - [in] short aAttributes ) + [in] short aAttributes ) raises( MalformedDataException, - com::sun::star::lang::WrappedTargetException ); - //------------------------------------------------------------------------- - + com::sun::star::lang::WrappedTargetException ); + //------------------------------------------------------------------------- + /** receives notification that a node description is complete. - <p> Must match the last open call to - <member>XLayerHandler::overrideNode()</member>, + <p> Must match the last open call to + <member>XLayerHandler::overrideNode()</member>, <member>XLayerHandler::addOrReplaceNode()</member> or <member>XLayerHandler::addOrReplaceNodeFromTemplate()</member>. </p> @@ -257,21 +257,21 @@ published interface XLayerHandler: ::com::sun::star::uno::XInterface @throws com::sun::star::configuration::backend::MalformedDataException <ul> <li>if invalid data is detected in the node</li> - <li>if no node is started at all</li> + <li>if no node is started at all</li> </ul> <p><em>Not every implementation can detect each condition</em></p> @throws com::sun::star::lang::WrappedTargetException if an error occurs processing the event. */ - void endNode( ) + void endNode( ) raises( MalformedDataException, - com::sun::star::lang::WrappedTargetException ); - //------------------------------------------------------------------------- + com::sun::star::lang::WrappedTargetException ); + //------------------------------------------------------------------------- + + /** receives notification that a node is dropped from a set. - /** receives notification that a node is dropped from a set. - - <p> The current node must be a set and + <p> The current node must be a set and the item must be removeable. </p> @@ -291,15 +291,15 @@ published interface XLayerHandler: ::com::sun::star::uno::XInterface @throws com::sun::star::lang::WrappedTargetException if an error occurs processing the event. */ - void dropNode( [in] string aName ) + void dropNode( [in] string aName ) raises( MalformedDataException, - com::sun::star::lang::WrappedTargetException ); - //------------------------------------------------------------------------- - + com::sun::star::lang::WrappedTargetException ); + //------------------------------------------------------------------------- + /** receives notification that an existing property is modified. - <p> Subsequent calls describe new value(s) for the property until a - matching call to <member>XLayerHandler::endProperty()</member> + <p> Subsequent calls describe new value(s) for the property until a + matching call to <member>XLayerHandler::endProperty()</member> is encountered. </p> @@ -309,38 +309,38 @@ published interface XLayerHandler: ::com::sun::star::uno::XInterface @param aAttributes specifies the new attributes of the property. - <p> The value is a combination of + <p> The value is a combination of <type>NodeAttribute</type> flags. </p> - <p> The attributes are combined cumulatively with those + <p> The attributes are combined cumulatively with those set on lower layers. </p> @param aType specifies the type of the property. - <p> This must be the same type as is already defined in the schema + <p> This must be the same type as is already defined in the schema or lower layers, unless the previous type was unspecified - (as indicated by + (as indicated by <const scope="com::sun::star::uno">TypeClass::ANY</const>.) </p> - <p> A <void/> type indicates that the type is unspecified - in this layer. - In this case any subsequent value may be of a generic type - (e.g. <atom>string</atom> or - for list values - - <atom dim="[]">string</atom>.) Such values may be - converted to the type defined in the schema by + <p> A <void/> type indicates that the type is unspecified + in this layer. + In this case any subsequent value may be of a generic type + (e.g. <atom>string</atom> or - for list values - + <atom dim="[]">string</atom>.) Such values may be + converted to the type defined in the schema by the implementation. </p> @param bClear - if <TRUE/>, specifies that the property should be cleared to an empty + if <TRUE/>, specifies that the property should be cleared to an empty state by discarding all values from lower layers prior - to applying the overrides. + to applying the overrides. @throws com::sun::star::configuration::backend::MalformedDataException <ul> - <li>if there isn't a group or extensible node in progress currently</li> + <li>if there isn't a group or extensible node in progress currently</li> <li>if there already was a change to a property of that name</li> <li>if there is no property with that name</li> <li>if the property is read-only</li> @@ -356,27 +356,27 @@ published interface XLayerHandler: ::com::sun::star::uno::XInterface @see com::sun::star::configuration::backend::NodeAttribute */ - void overrideProperty( [in] string aName, - [in] short aAttributes, - [in] type aType, - [in] boolean bClear ) + void overrideProperty( [in] string aName, + [in] short aAttributes, + [in] type aType, + [in] boolean bClear ) raises( MalformedDataException, - com::sun::star::lang::WrappedTargetException ); - - //------------------------------------------------------------------------- - - /** receives notification that the value of the current property + com::sun::star::lang::WrappedTargetException ); + + //------------------------------------------------------------------------- + + /** receives notification that the value of the current property is overridden. . @param aValue specifies the new value of the property. - <p> The value must match the type of the current property. - If the property does not have the + <p> The value must match the type of the current property. + If the property does not have the <const>SchemaAttribute::REQUIRED</const> flag set, the value can be <void/>. </p> - <p> If the current property is localized, this value applies + <p> If the current property is localized, this value applies to the default locale. </p> @@ -384,7 +384,7 @@ published interface XLayerHandler: ::com::sun::star::uno::XInterface <ul> <li>if there isn't a property in progress currently</li> <li>if there already was a change to the value of that property</li> - <li>if the value does not have the proper type</li> + <li>if the value does not have the proper type</li> <li>if the value is not valid for the property</li> </ul> <p><em>Not every implementation can detect each condition</em></p> @@ -394,20 +394,20 @@ published interface XLayerHandler: ::com::sun::star::uno::XInterface @see com::sun::star::configuration::backend::NodeAttribute */ - void setPropertyValue( [in] any aValue ) + void setPropertyValue( [in] any aValue ) raises( MalformedDataException, - com::sun::star::lang::WrappedTargetException ); - - //------------------------------------------------------------------------- - - /** receives notification that the value of the current localized property + com::sun::star::lang::WrappedTargetException ); + + //------------------------------------------------------------------------- + + /** receives notification that the value of the current localized property is overridden for a specific locale . @param aValue specifies the new value of the property. - <p> The value must match the type of the current property. - If the property does not have the + <p> The value must match the type of the current property. + If the property does not have the <const>SchemaAttribute::REQUIRED</const> flag set, the value can be <void/>. </p> @@ -431,36 +431,36 @@ published interface XLayerHandler: ::com::sun::star::uno::XInterface @see com::sun::star::configuration::backend::NodeAttribute */ - void setPropertyValueForLocale([in] any aValue, - [in] string aLocale ) + void setPropertyValueForLocale([in] any aValue, + [in] string aLocale ) raises( MalformedDataException, - com::sun::star::lang::WrappedTargetException ); - - //------------------------------------------------------------------------- - + com::sun::star::lang::WrappedTargetException ); + + //------------------------------------------------------------------------- + /** receives notification that a property description is complete. - <p> Must match an open call to - <member>XLayerHandler::overrideProperty()</member>, + <p> Must match an open call to + <member>XLayerHandler::overrideProperty()</member>, </p> @throws com::sun::star::configuration::backend::MalformedDataException <ul> <li>if invalid data is detected in the property</li> - <li>if no property is started at all</li> + <li>if no property is started at all</li> </ul> <p><em>Not every implementation can detect each condition</em></p> @throws com::sun::star::lang::WrappedTargetException if an error occurs processing the event. */ - void endProperty( ) + void endProperty( ) raises( MalformedDataException, - com::sun::star::lang::WrappedTargetException ); - //------------------------------------------------------------------------- - - /** receives notification that a property having a <void/> value is added - to the current node. + com::sun::star::lang::WrappedTargetException ); + //------------------------------------------------------------------------- + + /** receives notification that a property having a <void/> value is added + to the current node. <p> The current node must be extensible. </p> @@ -471,12 +471,12 @@ published interface XLayerHandler: ::com::sun::star::uno::XInterface @param aAttributes specifies the attributes of the new property. - <p> The value is a combination of - <type>NodeAttribute</type> flags and may also contain the + <p> The value is a combination of + <type>NodeAttribute</type> flags and may also contain the <const>SchemaAttribute::REQUIRED</const> flag. </p> - <p> <const>NodeAttribute::MANDATORY</const> need not be set, - as dynamically added properties always are mandatory + <p> <const>NodeAttribute::MANDATORY</const> need not be set, + as dynamically added properties always are mandatory in subsequent layers. </p> @@ -498,16 +498,16 @@ published interface XLayerHandler: ::com::sun::star::uno::XInterface @see com::sun::star::configuration::backend::SchemaAttribute */ - void addProperty( [in] string aName, - [in] short aAttributes, - [in] type aType ) + void addProperty( [in] string aName, + [in] short aAttributes, + [in] type aType ) raises( MalformedDataException, - com::sun::star::lang::WrappedTargetException ); - - //------------------------------------------------------------------------- - - /** receives notification that a property having a non-<void/> value - is added to the current node. + com::sun::star::lang::WrappedTargetException ); + + //------------------------------------------------------------------------- + + /** receives notification that a property having a non-<void/> value + is added to the current node. <p> The current node must be extensible. </p> @@ -518,20 +518,20 @@ published interface XLayerHandler: ::com::sun::star::uno::XInterface @param aAttributes specifies the attributes of the new property. - <p> The value is a combination of - <type>NodeAttribute</type> flags and may also contain the + <p> The value is a combination of + <type>NodeAttribute</type> flags and may also contain the <const>SchemaAttribute::REQUIRED</const> flag. </p> </p> - <p> <const>NodeAttribute::MANDATORY</const> need not be set, - as dynamic properties always are mandatory + <p> <const>NodeAttribute::MANDATORY</const> need not be set, + as dynamic properties always are mandatory in subsequent layers. </p> @param aValue specifies the value of the new property. - <p> The value also determines the type. + <p> The value also determines the type. Therefore the value must not be <void/>. </p> @@ -552,19 +552,19 @@ published interface XLayerHandler: ::com::sun::star::uno::XInterface @see com::sun::star::configuration::backend::SchemaAttribute */ - void addPropertyWithValue( [in] string aName, - [in] short aAttributes, - [in] any aValue ) + void addPropertyWithValue( [in] string aName, + [in] short aAttributes, + [in] any aValue ) raises( MalformedDataException, - com::sun::star::lang::WrappedTargetException ); - - //------------------------------------------------------------------------- -}; - -//============================================================================= - -}; }; }; }; }; - -//============================================================================= - -#endif + com::sun::star::lang::WrappedTargetException ); + + //------------------------------------------------------------------------- +}; + +//============================================================================= + +}; }; }; }; }; + +//============================================================================= + +#endif diff --git a/offapi/com/sun/star/configuration/backend/XLayerImporter.idl b/offapi/com/sun/star/configuration/backend/XLayerImporter.idl index ee0d686dd640..9a47b0e8dab1 100644 --- a/offapi/com/sun/star/configuration/backend/XLayerImporter.idl +++ b/offapi/com/sun/star/configuration/backend/XLayerImporter.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -29,19 +29,19 @@ #ifndef __com_sun_star_uno_XInterface_idl__ #include <com/sun/star/uno/XInterface.idl> -#endif +#endif #ifndef __com_sun_star_configuration_backend_XLayer_idl__ #include <com/sun/star/configuration/backend/XLayer.idl> -#endif +#endif #ifndef __com_sun_star_configuration_backend_XBackend_idl__ #include <com/sun/star/configuration/backend/XBackend.idl> -#endif +#endif #ifndef __com_sun_star_configuration_backend_MalformedDataException_idl__ #include <com/sun/star/configuration/backend/MalformedDataException.idl> -#endif +#endif #ifndef __com_sun_star_lang_NullPointerException_idl__ #include <com/sun/star/lang/NullPointerException.idl> #endif @@ -52,19 +52,19 @@ #include <com/sun/star/lang/WrappedTargetException.idl> #endif -//============================================================================= +//============================================================================= module com { module sun { module star { module configuration { module backend { -//============================================================================= +//============================================================================= /** allows importing a layer into a <type>Backend</type> - + @since OOo 1.1.2 */ -published interface XLayerImporter : ::com::sun::star::uno::XInterface +published interface XLayerImporter : ::com::sun::star::uno::XInterface { - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- /** gets the target backend for importing. @@ -75,7 +75,7 @@ published interface XLayerImporter : ::com::sun::star::uno::XInterface */ XBackend getTargetBackend(); - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- /** sets the target backend for importing. @@ -89,7 +89,7 @@ published interface XLayerImporter : ::com::sun::star::uno::XInterface void setTargetBackend([in] XBackend aBackend) raises (com::sun::star::lang::NullPointerException) ; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- /** Imports the layer given into the backend. @@ -103,9 +103,9 @@ published interface XLayerImporter : ::com::sun::star::uno::XInterface @throws com::sun::star::configuration::backend::MalformedDataException if the layer passed is invalid - + @throws com::sun::star::lang::IllegalArgumentException - if the layer passed is for a component + if the layer passed is for a component that doesn't exist in the backend @throws com::sun::star::lang::WrappedTargetException @@ -119,7 +119,7 @@ published interface XLayerImporter : ::com::sun::star::uno::XInterface com::sun::star::lang::NullPointerException, com::sun::star::lang::WrappedTargetException) ; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- /** Imports the layer given into the backend for a given entity. @@ -136,9 +136,9 @@ published interface XLayerImporter : ::com::sun::star::uno::XInterface @throws com::sun::star::configuration::backend::MalformedDataException if the layer passed is invalid - + @throws com::sun::star::lang::IllegalArgumentException - if the layer passed is for a component + if the layer passed is for a component that doesn't exist in the backend or if the entity doesn't exist in the backend. @@ -153,11 +153,11 @@ published interface XLayerImporter : ::com::sun::star::uno::XInterface com::sun::star::lang::NullPointerException, com::sun::star::lang::WrappedTargetException) ; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- } ; -//============================================================================= +//============================================================================= -} ; } ; } ; } ; } ; +} ; } ; } ; } ; } ; -#endif +#endif diff --git a/offapi/com/sun/star/configuration/backend/XMultiLayerStratum.idl b/offapi/com/sun/star/configuration/backend/XMultiLayerStratum.idl index 0f28433a24f6..a83ddfcf07c7 100644 --- a/offapi/com/sun/star/configuration/backend/XMultiLayerStratum.idl +++ b/offapi/com/sun/star/configuration/backend/XMultiLayerStratum.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -29,11 +29,11 @@ #ifndef __com_sun_star_uno_XInterface_idl__ #include <com/sun/star/uno/XInterface.idl> -#endif +#endif #ifndef __com_sun_star_configuration_backend_XLayer_idl__ #include <com/sun/star/configuration/backend/XLayer.idl> -#endif +#endif #ifndef __com_sun_star_configuration_backend_XUpdatableLayer_idl__ #include <com/sun/star/configuration/backend/XUpdatableLayer.idl> @@ -45,23 +45,23 @@ #ifndef __com_sun_star_lang_IllegalArgumentException_idl__ #include <com/sun/star/lang/IllegalArgumentException.idl> -#endif +#endif #ifndef __com_sun_star_lang_NoSupportException_idl__ #include <com/sun/star/lang/NoSupportException.idl> -#endif +#endif -//============================================================================= +//============================================================================= module com { module sun { module star { module configuration { module backend { -//============================================================================= +//============================================================================= -/** - Handles access to a stratum consisting of multiple layers +/** + Handles access to a stratum consisting of multiple layers in a single configuration data repository - - <p> The interface provides access to data for multiple entities and + + <p> The interface provides access to data for multiple entities and timestamp-checking capabilities for efficient caching. </p> @@ -72,33 +72,33 @@ module com { module sun { module star { module configuration { module backend { @since OOo 1.1.2 */ -published interface XMultiLayerStratum : ::com::sun::star::uno::XInterface +published interface XMultiLayerStratum : ::com::sun::star::uno::XInterface { - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- - /** + /** identifies the layers within this stratum which should be read and merged to determine data of a component for an entity + - - @param aComponent + @param aComponent The name of the component to access. - @param aEntity - The name of an entity on behalf of which data will be accessed. + @param aEntity + The name of an entity on behalf of which data will be accessed. - @return + @return a list of layer identifiers that can be used to retrieve <type>Layer</type> objects. - <p> The list ist ordered by priority. Typically - the most general layers (global defaults, - entire organization) are first, more specific layers - (associated to specific groups or roles) are next + <p> The list ist ordered by priority. Typically + the most general layers (global defaults, + entire organization) are first, more specific layers + (associated to specific groups or roles) are next and the entity's own data is last. </p> @throws com::sun::star::lang::IllegalArgumentException - if the component identifier is invalid or + if the component identifier is invalid or if the entity doesn't exist. @throws com::sun::star::configuration::backend::BackendAccessException @@ -109,29 +109,29 @@ published interface XMultiLayerStratum : ::com::sun::star::uno::XInterface @see com::sun::star::configuration::backend::XMultiLayerStratum::getMultipleLayers() @see com::sun::star::configuration::backend::XBackendEntities */ - sequence<string> listLayerIds([in] string aComponent, - [in] string aEntity) + sequence<string> listLayerIds([in] string aComponent, + [in] string aEntity) raises (BackendAccessException, com::sun::star::lang::IllegalArgumentException) ; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- - /** - identifies the layer which should be modified + /** + identifies the layer which should be modified to update data of a component on behalf of an entity. - <p> The layer id returned is one of the layer ids obtained from - <member>XMultiLayerStratum::listLayerIds()</member> for the same - component and entity. + <p> The layer id returned is one of the layer ids obtained from + <member>XMultiLayerStratum::listLayerIds()</member> for the same + component and entity. </p> - @param aComponent + @param aComponent The name of the component to access. - @param aEntity - The name of an entity on behalf of which data will be accessed. + @param aEntity + The name of an entity on behalf of which data will be accessed. - @returns + @returns a layer identifier that can be used to obtain an <type>UpdatableLayer</type> object. @@ -154,92 +154,92 @@ published interface XMultiLayerStratum : ::com::sun::star::uno::XInterface com::sun::star::lang::NoSupportException, com::sun::star::lang::IllegalArgumentException) ; - //------------------------------------------------------------------------- - - /** - retrieves a layer associated to a layer id, if newer than indicated. + //------------------------------------------------------------------------- - <p> A timestamp can be provided, which is used to indicate - a point in time. The layer should be returned only if is modified - since that time. + /** + retrieves a layer associated to a layer id, if newer than indicated. + + <p> A timestamp can be provided, which is used to indicate + a point in time. The layer should be returned only if is modified + since that time. </p> - @param aLayerId + @param aLayerId identifier of the layers to be accessed. - <p>Layer ids can be obtained from - <member>XMultiLayerStratum::listLayerIds()</member> or - <member>XMultiLayerStratum::getUpdateLayerId()</member>. + <p>Layer ids can be obtained from + <member>XMultiLayerStratum::listLayerIds()</member> or + <member>XMultiLayerStratum::getUpdateLayerId()</member>. </p> - @param aTimestamp + @param aTimestamp a timestamp for the layer. - - <p> An empty timestamp indicates, that the layer should be - retrieved irrespective of its modification time. + + <p> An empty timestamp indicates, that the layer should be + retrieved irrespective of its modification time. </p> - <p> The format and meaning of a timestamp depends on - the implementation. Timestamps can be obtained using + <p> The format and meaning of a timestamp depends on + the implementation. Timestamps can be obtained using <member scope="com::sun::star::util">XTimeStamped::getTimestamp()</member>. </p> - @returns - a <type>Layer</type> object providing access to the layer data, - <NULL/> if the layer is newer than indicated by the timestamp. + @returns + a <type>Layer</type> object providing access to the layer data, + <NULL/> if the layer is newer than indicated by the timestamp. @throws com::sun::star::lang::IllegalArgumentException - if the layer id is invalid or - if the timestamp is invalid + if the layer id is invalid or + if the timestamp is invalid @throws com::sun::star::configuration::backend::BackendAccessException if an error occurs while accessing the data. @see com::sun::star::util::XTimeStamped */ - XLayer getLayer([in] string aLayerId, + XLayer getLayer([in] string aLayerId, [in] string aTimestamp) raises (BackendAccessException, com::sun::star::lang::IllegalArgumentException) ; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- - /** - retrieves the layers associated to a series of layer ids, - if newer than indicated. - <p> A timestamp can be provided, which is used to indicate - a point in time. Only layers that are modified since that time - should be returned. The same timestamp is used for all layers. + /** + retrieves the layers associated to a series of layer ids, + if newer than indicated. + <p> A timestamp can be provided, which is used to indicate + a point in time. Only layers that are modified since that time + should be returned. The same timestamp is used for all layers. </p> - @param aLayerIds + @param aLayerIds identifiers of the layers to be accessed. - <p>Layer ids can be obtained from - <member>XMultiLayerStratum::listLayerIds()</member>. + <p>Layer ids can be obtained from + <member>XMultiLayerStratum::listLayerIds()</member>. </p> - @param aTimestamp - a timestamp for all of the layers. - <p> An empty timestamp indicates, that the layers should be - retrieved irrespective of their modification time. + @param aTimestamp + a timestamp for all of the layers. + <p> An empty timestamp indicates, that the layers should be + retrieved irrespective of their modification time. </p> - <p> The format and meaning of a timestamp depends on - the implementation. Timestamps can be obtained using + <p> The format and meaning of a timestamp depends on + the implementation. Timestamps can be obtained using <member scope="com::sun::star::util">XTimeStamped::getTimestamp()</member>. </p> - @returns - a list of <type>Layer</type> objects - providing access to the layer data. - <p> The list has the same length as aLayerIds. Each layer - object is associated to the layer id in the corresponding + @returns + a list of <type>Layer</type> objects + providing access to the layer data. + <p> The list has the same length as aLayerIds. Each layer + object is associated to the layer id in the corresponding position. </p> - <p> For layers that are newer than indicated by the + <p> For layers that are newer than indicated by the timestamp, the list contains a <NULL/> element. </p> @throws com::sun::star::lang::IllegalArgumentException - if one of the layer ids is invalid or - if the timestamp is invalid + if one of the layer ids is invalid or + if the timestamp is invalid @throws com::sun::star::configuration::backend::BackendAccessException if an error occurs while accessing the data. @@ -251,41 +251,41 @@ published interface XMultiLayerStratum : ::com::sun::star::uno::XInterface raises (BackendAccessException, com::sun::star::lang::IllegalArgumentException) ; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- /** - retrieves the layers associated to a series of layer ids, - if newer than indicated for each layer. - <p> For each layer an individual timestamp can be provided, - which is used to indicate the last known version of the layer. + retrieves the layers associated to a series of layer ids, + if newer than indicated for each layer. + <p> For each layer an individual timestamp can be provided, + which is used to indicate the last known version of the layer. Only layers that are modified since that time should be returned. </p> - @param aLayerIds - identifiers of the layers to be accessed. - <p>Layer ids can be obtained from - <member>XMultiLayerStratum::listLayerIds()</member>. + @param aLayerIds + identifiers of the layers to be accessed. + <p>Layer ids can be obtained from + <member>XMultiLayerStratum::listLayerIds()</member>. </p> - @param aTimestamps + @param aTimestamps timestamps for each of the layers. - - <p> This list must have the same length as aLayerIds. - Timestamps are matched to layer ids by their position. + + <p> This list must have the same length as aLayerIds. + Timestamps are matched to layer ids by their position. </p> - <p> An empty timestamp indicates, that the associated layer + <p> An empty timestamp indicates, that the associated layer should be retrieved irrespective of its modification time. </p> - <p> The format and meaning of a timestamp depends on - the implementation. Timestamps can be obtained using + <p> The format and meaning of a timestamp depends on + the implementation. Timestamps can be obtained using <member scope="com::sun::star::util">XTimeStamped::getTimestamp()</member>. </p> - @returns - a list of <type>Layer</type> objects - providing access to the layer data. - <p> The list has the same length as aLayerIds. Each layer - object is associated to the layer id in the corresponding + @returns + a list of <type>Layer</type> objects + providing access to the layer data. + <p> The list has the same length as aLayerIds. Each layer + object is associated to the layer id in the corresponding position. </p> <p> For layers that are newer than indicated by the corresponding @@ -293,8 +293,8 @@ published interface XMultiLayerStratum : ::com::sun::star::uno::XInterface </p> @throws com::sun::star::lang::IllegalArgumentException - if one of the layer ids is invalid or - if one of the timestamps is invalid or + if one of the layer ids is invalid or + if one of the timestamps is invalid or if the lengths of the arguments don't match. @throws com::sun::star::configuration::backend::BackendAccessException @@ -307,20 +307,20 @@ published interface XMultiLayerStratum : ::com::sun::star::uno::XInterface raises (BackendAccessException, com::sun::star::lang::IllegalArgumentException) ; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- /** - retrieves a writable representation of the layer - associated to a layer id. + retrieves a writable representation of the layer + associated to a layer id. - @param aLayerId - identifier of the layer to be accessed for writing. - <p>A layer id for writing can be obtained from - <member>XMultiLayerStratum::getUpdateLayerId()</member>. + @param aLayerId + identifier of the layer to be accessed for writing. + <p>A layer id for writing can be obtained from + <member>XMultiLayerStratum::getUpdateLayerId()</member>. </p> - @return - an <type>UpdatableLayer</type> object providing + @return + an <type>UpdatableLayer</type> object providing write access to the layer @throws com::sun::star::lang::IllegalArgumentException @@ -336,12 +336,12 @@ published interface XMultiLayerStratum : ::com::sun::star::uno::XInterface raises (BackendAccessException, com::sun::star::lang::NoSupportException, com::sun::star::lang::IllegalArgumentException) ; - - //------------------------------------------------------------------------- + + //------------------------------------------------------------------------- } ; -//============================================================================= +//============================================================================= } ; } ; } ; } ; } ; -#endif +#endif diff --git a/offapi/com/sun/star/configuration/backend/XSchema.idl b/offapi/com/sun/star/configuration/backend/XSchema.idl index 6f761216fd39..440d4b027876 100644 --- a/offapi/com/sun/star/configuration/backend/XSchema.idl +++ b/offapi/com/sun/star/configuration/backend/XSchema.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -29,46 +29,46 @@ #ifndef __com_sun_star_uno_XInterface_idl__ #include <com/sun/star/uno/XInterface.idl> -#endif +#endif #ifndef __com_sun_star_configuration_backend_XSchemaHandler_idl__ #include <com/sun/star/configuration/backend/XSchemaHandler.idl> -#endif +#endif #ifndef __com_sun_star_lang_NullPointerException_idl__ #include <com/sun/star/lang/NullPointerException.idl> -#endif +#endif #ifndef __com_sun_star_lang_WrappedTargetException_idl__ #include <com/sun/star/lang/WrappedTargetException.idl> -#endif +#endif #ifndef __com_sun_star_configuration_backend_MalformedDataException_idl__ #include <com/sun/star/configuration/backend/MalformedDataException.idl> #endif -//============================================================================= +//============================================================================= module com { module sun { module star { module configuration { module backend { -//============================================================================= +//============================================================================= -/** +/** Handles access to the elements of a component schema, i.e its templates and its component definition. @since OOo 1.1.2 */ -published interface XSchema : ::com::sun::star::uno::XInterface +published interface XSchema : ::com::sun::star::uno::XInterface { - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- - /** - Describes the full schema (templates + component) to a + /** + Describes the full schema (templates + component) to a <type>XSchemaHandler</type>. - @param aHandler - schema handler that will receive calls + @param aHandler + schema handler that will receive calls describing the contents of the templates and the component definition @@ -77,7 +77,7 @@ published interface XSchema : ::com::sun::star::uno::XInterface @throws com::sun::star::lang::WrappedTargetException if an error occurs in the access to or processing of the data or if a subsequent call to any of the <type>XSchema</type>methods is made. - The elements of a component schema are only parsed once,a repeat call + The elements of a component schema are only parsed once,a repeat call leads to exception. @throws com::sun::star::configuration::backend::MalformedDataException if the data read from the layer is rejected as invalid by the @@ -88,13 +88,13 @@ published interface XSchema : ::com::sun::star::uno::XInterface com::sun::star::lang::WrappedTargetException, MalformedDataException) ; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- /** Describes only the component definition to a <type>XSchemaHandler</type>. - @param aHandler - schema handler that will receive calls + @param aHandler + schema handler that will receive calls describing the contents of the component definition @@ -103,7 +103,7 @@ published interface XSchema : ::com::sun::star::uno::XInterface @throws com::sun::star::lang::WrappedTargetException if an error occurs in the access to or processing of the data or if a subsequent call to any of the <type>XSchema</type>methods is made. - The elements of a component schema are only parsed once,a repeat call + The elements of a component schema are only parsed once,a repeat call leads to exception. @throws com::sun::star::configuration::backend::MalformedDataException if the data read from the layer is rejected as invalid by the @@ -114,13 +114,13 @@ published interface XSchema : ::com::sun::star::uno::XInterface com::sun::star::lang::WrappedTargetException, MalformedDataException) ; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- - /** + /** Describes the component templates to a <type>XSchemaHandler</type>. - @param aHandler - schema handler that will receive calls + @param aHandler + schema handler that will receive calls describing the contents of the templates @throws com::sun::star::lang::NullPointerException @@ -128,7 +128,7 @@ published interface XSchema : ::com::sun::star::uno::XInterface @throws com::sun::star::lang::WrappedTargetException if an error occurs in the access to or processing of the data or if a subsequent call to any of the <type>XSchema</type>methods is made. - The elements of a component schema are only parsed once,a repeat call + The elements of a component schema are only parsed once,a repeat call leads to exception. @throws com::sun::star::configuration::backend::MalformedDataException if the data read from the layer is rejected as invalid by the @@ -139,10 +139,10 @@ published interface XSchema : ::com::sun::star::uno::XInterface com::sun::star::lang::WrappedTargetException, MalformedDataException) ; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- } ; -//============================================================================= +//============================================================================= } ; } ; } ; } ; } ; -#endif +#endif diff --git a/offapi/com/sun/star/configuration/backend/XSchemaHandler.idl b/offapi/com/sun/star/configuration/backend/XSchemaHandler.idl index 635eb6164bbd..8112541a8a1b 100644 --- a/offapi/com/sun/star/configuration/backend/XSchemaHandler.idl +++ b/offapi/com/sun/star/configuration/backend/XSchemaHandler.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -24,39 +24,39 @@ * for a copy of the LGPLv3 License. * ************************************************************************/ -#ifndef __com_sun_star_configuration_backend_XSchemaHandler_idl__ +#ifndef __com_sun_star_configuration_backend_XSchemaHandler_idl__ #define __com_sun_star_configuration_backend_XSchemaHandler_idl__ - -#ifndef __com_sun_star_uno_XInterface_idl__ -#include <com/sun/star/uno/XInterface.idl> -#endif - -#ifndef __com_sun_star_configuration_backend_TemplateIdentifier_idl__ -#include <com/sun/star/configuration/backend/TemplateIdentifier.idl> -#endif - -#ifndef __com_sun_star_configuration_backend_MalformedDataException_idl__ -#include <com/sun/star/configuration/backend/MalformedDataException.idl> -#endif - -#ifndef __com_sun_star_lang_WrappedTargetException_idl__ -#include <com/sun/star/lang/WrappedTargetException.idl> -#endif + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_configuration_backend_TemplateIdentifier_idl__ +#include <com/sun/star/configuration/backend/TemplateIdentifier.idl> +#endif + +#ifndef __com_sun_star_configuration_backend_MalformedDataException_idl__ +#include <com/sun/star/configuration/backend/MalformedDataException.idl> +#endif + +#ifndef __com_sun_star_lang_WrappedTargetException_idl__ +#include <com/sun/star/lang/WrappedTargetException.idl> +#endif //============================================================================= - + module com { module sun { module star { module configuration { module backend { - -//============================================================================= - + +//============================================================================= + /** receives a description of a configuration schema as a sequence of events. @since OOo 1.1.2 */ published interface XSchemaHandler: ::com::sun::star::uno::XInterface -{ - //------------------------------------------------------------------------- - +{ + //------------------------------------------------------------------------- + /** receives notification that a schema description is started. <p> The schema descrption may comprise components templates or both. @@ -70,9 +70,9 @@ published interface XSchemaHandler: ::com::sun::star::uno::XInterface */ void startSchema( ) raises( MalformedDataException, - com::sun::star::lang::WrappedTargetException ); - //------------------------------------------------------------------------- - + com::sun::star::lang::WrappedTargetException ); + //------------------------------------------------------------------------- + /** receives notification that the current schema description is complete. <p> Must match a previous call to <member>startSchema</member>. @@ -91,9 +91,9 @@ published interface XSchemaHandler: ::com::sun::star::uno::XInterface */ void endSchema( ) raises( MalformedDataException, - com::sun::star::lang::WrappedTargetException ); - //------------------------------------------------------------------------- - + com::sun::star::lang::WrappedTargetException ); + //------------------------------------------------------------------------- + /** receives notification that the schema depends on templates from a different component. @@ -112,11 +112,11 @@ published interface XSchemaHandler: ::com::sun::star::uno::XInterface @throws com::sun::star::lang::WrappedTargetException if an error occurs processing the event. */ - void importComponent( [in] string aName ) + void importComponent( [in] string aName ) raises( MalformedDataException, - com::sun::star::lang::WrappedTargetException ); - //------------------------------------------------------------------------- - + com::sun::star::lang::WrappedTargetException ); + //------------------------------------------------------------------------- + /** receives notification that a component description is started. <p> Subsequent calls describe the schema of the component @@ -140,11 +140,11 @@ published interface XSchemaHandler: ::com::sun::star::uno::XInterface @throws com::sun::star::lang::WrappedTargetException if an error occurs processing the event. */ - void startComponent( [in] string aName ) + void startComponent( [in] string aName ) raises( MalformedDataException, - com::sun::star::lang::WrappedTargetException ); - //------------------------------------------------------------------------- - + com::sun::star::lang::WrappedTargetException ); + //------------------------------------------------------------------------- + /** receives notification that a component description is complete. <p> Must match a previous call to <member>startComponent</member>. @@ -162,11 +162,11 @@ published interface XSchemaHandler: ::com::sun::star::uno::XInterface @throws com::sun::star::lang::WrappedTargetException if an error occurs processing the event. */ - void endComponent( ) + void endComponent( ) raises( MalformedDataException, - com::sun::star::lang::WrappedTargetException ); - //------------------------------------------------------------------------- - + com::sun::star::lang::WrappedTargetException ); + //------------------------------------------------------------------------- + /** receives notification that a template description is started for a group. <p> Subsequent calls describe the members and properties of the template @@ -180,11 +180,11 @@ published interface XSchemaHandler: ::com::sun::star::uno::XInterface @param aAttributes specifies the attributes of the template. - <p> The value is a combination of + <p> The value is a combination of <type>SchemaAttribute</type> flags. </p> - <p> <const>SchemaAttribute::EXTENSIBLE</const> can be used - to describe a template for a node with an extensible + <p> <const>SchemaAttribute::EXTENSIBLE</const> can be used + to describe a template for a node with an extensible set of properties. </p> @@ -205,11 +205,11 @@ published interface XSchemaHandler: ::com::sun::star::uno::XInterface @see com::sun::star::configuration::backend::SchemaAttribute */ void startGroupTemplate( [in] TemplateIdentifier aTemplate, - [in] short aAttributes ) + [in] short aAttributes ) raises( MalformedDataException, - com::sun::star::lang::WrappedTargetException ); - //------------------------------------------------------------------------- - + com::sun::star::lang::WrappedTargetException ); + //------------------------------------------------------------------------- + /** receives notification that a template description is started for a set. <p> Subsequent calls describe the members and properties of the template @@ -223,11 +223,11 @@ published interface XSchemaHandler: ::com::sun::star::uno::XInterface @param aAttributes specifies the attributes of the template. - <p> The value is a combination of + <p> The value is a combination of <type>SchemaAttribute</type> flags. </p> - <p> <const>SchemaAttribute::EXTENSIBLE</const> can be used - to describe a template for a node with an extensible + <p> <const>SchemaAttribute::EXTENSIBLE</const> can be used + to describe a template for a node with an extensible set of properties. </p> @@ -251,13 +251,13 @@ published interface XSchemaHandler: ::com::sun::star::uno::XInterface @see com::sun::star::configuration::backend::SchemaAttribute */ - void startSetTemplate( [in] TemplateIdentifier aTemplate, - [in] short aAttributes, - [in] TemplateIdentifier aItemType ) + void startSetTemplate( [in] TemplateIdentifier aTemplate, + [in] short aAttributes, + [in] TemplateIdentifier aItemType ) raises( MalformedDataException, - com::sun::star::lang::WrappedTargetException ); - //------------------------------------------------------------------------- - + com::sun::star::lang::WrappedTargetException ); + //------------------------------------------------------------------------- + /** receives notification that a template description is complete. <p> Must match a previous call to <member>startGroupTemplate</member> @@ -276,11 +276,11 @@ published interface XSchemaHandler: ::com::sun::star::uno::XInterface @throws com::sun::star::lang::WrappedTargetException if an error occurs processing the event. */ - void endTemplate( ) + void endTemplate( ) raises( MalformedDataException, - com::sun::star::lang::WrappedTargetException ); - //------------------------------------------------------------------------- - + com::sun::star::lang::WrappedTargetException ); + //------------------------------------------------------------------------- + /** receives notification that a group description is started. <p> Subsequent calls describe the members and properties of the group @@ -294,10 +294,10 @@ published interface XSchemaHandler: ::com::sun::star::uno::XInterface @param aAttributes specifies the attributes of the node. - <p> The value is a combination of + <p> The value is a combination of <type>SchemaAttribute</type> flags. </p> - <p> <const>SchemaAttribute::EXTENSIBLE</const> can be used + <p> <const>SchemaAttribute::EXTENSIBLE</const> can be used to describe a group with an extensible set of properties. </p> @@ -305,7 +305,7 @@ published interface XSchemaHandler: ::com::sun::star::uno::XInterface <ul> <li>if there isn't a group node in progress currently</li> <li>if there already is a node with that name</li> - <li>if the name is not a valid node name</li> + <li>if the name is not a valid node name</li> <li>if the attributes are not valid for a group</li> </ul> <p><em>Not every implementation can detect each condition</em></p> @@ -316,11 +316,11 @@ published interface XSchemaHandler: ::com::sun::star::uno::XInterface @see com::sun::star::configuration::backend::SchemaAttribute */ void startGroup( [in] string aName, - [in] short aAttributes ) + [in] short aAttributes ) raises( MalformedDataException, - com::sun::star::lang::WrappedTargetException ); - //------------------------------------------------------------------------- - + com::sun::star::lang::WrappedTargetException ); + //------------------------------------------------------------------------- + /** receives notification that a set description is started. <p> Subsequent calls describe the item-types and properties of the set @@ -334,10 +334,10 @@ published interface XSchemaHandler: ::com::sun::star::uno::XInterface @param aAttributes specifies the attributes of the node. - <p> The value is a combination of + <p> The value is a combination of <type>SchemaAttribute</type> flags. </p> - <p> <const>SchemaAttribute::EXTENSIBLE</const> can be used + <p> <const>SchemaAttribute::EXTENSIBLE</const> can be used to describe a set with an extensible set of properties. </p> @@ -350,7 +350,7 @@ published interface XSchemaHandler: ::com::sun::star::uno::XInterface <li>if there already is a node with that name</li> <li>if the item-type template is not found</li> <li>if the name is not a valid node name</li> - <li>if the item-type is not a valid template identifier</li> + <li>if the item-type is not a valid template identifier</li> <li>if the attributes are not valid for a set</li> </ul> <p><em>Not every implementation can detect each condition</em></p> @@ -361,12 +361,12 @@ published interface XSchemaHandler: ::com::sun::star::uno::XInterface @see com::sun::star::configuration::backend::SchemaAttribute */ void startSet( [in] string aName, - [in] short aAttributes, - [in] TemplateIdentifier aItemType ) + [in] short aAttributes, + [in] TemplateIdentifier aItemType ) raises( MalformedDataException, - com::sun::star::lang::WrappedTargetException ); - //------------------------------------------------------------------------- - + com::sun::star::lang::WrappedTargetException ); + //------------------------------------------------------------------------- + /** receives notification that a node description is complete. <p> Must match the last open call to <member>startGroup</member> @@ -384,14 +384,14 @@ published interface XSchemaHandler: ::com::sun::star::uno::XInterface @throws com::sun::star::lang::WrappedTargetException if an error occurs processing the event. */ - void endNode( ) + void endNode( ) raises( MalformedDataException, - com::sun::star::lang::WrappedTargetException ); - //------------------------------------------------------------------------- - - /** receives notification that a property is added to the current node. + com::sun::star::lang::WrappedTargetException ); + //------------------------------------------------------------------------- + + /** receives notification that a property is added to the current node. - <p> The property will have a default value of <NULL/> + <p> The property will have a default value of <NULL/> (unless it is <const>SchemaAttribute::REQUIRED</const>). </p> @@ -401,7 +401,7 @@ published interface XSchemaHandler: ::com::sun::star::uno::XInterface @param aAttributes specifies the attributes of the new property. - <p> The value is a combination of + <p> The value is a combination of <type>SchemaAttribute</type> flags. </p> @@ -413,7 +413,7 @@ published interface XSchemaHandler: ::com::sun::star::uno::XInterface <li>if there isn't a group or extensible node in progress currently</li> <li>if a property with the same name already exists</li> <li>if the specified type is not allowed</li> - <li>if the name is not a valid property name</li> + <li>if the name is not a valid property name</li> <li>if the attributes are not valid for a property</li> </ul> <p><em>Not every implementation can detect each condition</em></p> @@ -423,16 +423,16 @@ published interface XSchemaHandler: ::com::sun::star::uno::XInterface @see com::sun::star::configuration::backend::SchemaAttribute */ - void addProperty( [in] string aName, - [in] short aAttributes, - [in] type aType ) + void addProperty( [in] string aName, + [in] short aAttributes, + [in] type aType ) raises( MalformedDataException, - com::sun::star::lang::WrappedTargetException ); - - //------------------------------------------------------------------------- - - /** receives notification that a property having a default value - is added to the current node. + com::sun::star::lang::WrappedTargetException ); + + //------------------------------------------------------------------------- + + /** receives notification that a property having a default value + is added to the current node. @param aName specifies the name of the new property. @@ -440,14 +440,14 @@ published interface XSchemaHandler: ::com::sun::star::uno::XInterface @param aAttributes specifies the attributes of the new property. - <p> The value is a combination of + <p> The value is a combination of <type>SchemaAttribute</type> flags. </p> @param aDefaultValue specifies the value of the new property. - <p> The value also determines the type. + <p> The value also determines the type. Therefore the value must not be <void/>. </p> @@ -456,7 +456,7 @@ published interface XSchemaHandler: ::com::sun::star::uno::XInterface <li>if there isn't a group or extensible node in progress currently</li> <li>if a property with the same name already exists</li> <li>if the type of the default value is not an allowed type, - or if the default value is <void/></li> + or if the default value is <void/></li> <li>if the name is not a valid property name</li> <li>if the attributes are not valid for a property</li> </ul> @@ -467,15 +467,15 @@ published interface XSchemaHandler: ::com::sun::star::uno::XInterface @see com::sun::star::configuration::backend::SchemaAttribute */ - void addPropertyWithDefault( [in] string aName, - [in] short aAttributes, - [in] any aDefaultValue ) + void addPropertyWithDefault( [in] string aName, + [in] short aAttributes, + [in] any aDefaultValue ) raises( MalformedDataException, - com::sun::star::lang::WrappedTargetException ); - - //------------------------------------------------------------------------- - - /** receives notification that the current group has a child node + com::sun::star::lang::WrappedTargetException ); + + //------------------------------------------------------------------------- + + /** receives notification that the current group has a child node that is an instance of a specified template. @param aName @@ -496,18 +496,18 @@ published interface XSchemaHandler: ::com::sun::star::uno::XInterface @throws com::sun::star::lang::WrappedTargetException if an error occurs processing the event. */ - void addInstance( [in] string aName, - [in] TemplateIdentifier aTemplate ) + void addInstance( [in] string aName, + [in] TemplateIdentifier aTemplate ) raises( MalformedDataException, - com::sun::star::lang::WrappedTargetException ); - - //------------------------------------------------------------------------- - - /** receives notification that the current set can contain items + com::sun::star::lang::WrappedTargetException ); + + //------------------------------------------------------------------------- + + /** receives notification that the current set can contain items that are instances of a specified template. @param aItemType - specifies a template that is accepted as valid item type + specifies a template that is accepted as valid item type for the current set node. @throws com::sun::star::configuration::backend::MalformedDataException @@ -521,18 +521,18 @@ published interface XSchemaHandler: ::com::sun::star::uno::XInterface @throws com::sun::star::lang::WrappedTargetException if an error occurs processing the event. */ - void addItemType( [in] TemplateIdentifier aItemType ) + void addItemType( [in] TemplateIdentifier aItemType ) raises( MalformedDataException, - com::sun::star::lang::WrappedTargetException ); - - //------------------------------------------------------------------------- - -}; - -//============================================================================= - -}; }; }; }; }; - -//============================================================================= - -#endif + com::sun::star::lang::WrappedTargetException ); + + //------------------------------------------------------------------------- + +}; + +//============================================================================= + +}; }; }; }; }; + +//============================================================================= + +#endif diff --git a/offapi/com/sun/star/configuration/backend/XSchemaSupplier.idl b/offapi/com/sun/star/configuration/backend/XSchemaSupplier.idl index d8005be6a38b..d7ae32edd5dd 100644 --- a/offapi/com/sun/star/configuration/backend/XSchemaSupplier.idl +++ b/offapi/com/sun/star/configuration/backend/XSchemaSupplier.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -29,11 +29,11 @@ #ifndef __com_sun_star_uno_XInterface_idl__ #include <com/sun/star/uno/XInterface.idl> -#endif +#endif #ifndef __com_sun_star_configuration_backend_XSchema_idl__ #include <com/sun/star/configuration/backend/XSchema.idl> -#endif +#endif #ifndef __com_sun_star_configuration_backend_BackendAccessException_idl__ #include <com/sun/star/configuration/backend/BackendAccessException.idl> @@ -41,31 +41,31 @@ #ifndef __com_sun_star_lang_IllegalArgumentException_idl__ #include <com/sun/star/lang/IllegalArgumentException.idl> -#endif +#endif -//============================================================================= +//============================================================================= module com { module sun { module star { module configuration { module backend { -//============================================================================= +//============================================================================= -/** +/** provides access to configuration component schemas. @since OOo 1.1.2 */ -published interface XSchemaSupplier : ::com::sun::star::uno::XInterface +published interface XSchemaSupplier : ::com::sun::star::uno::XInterface { - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- /** Returns the schema information (component + templates) for a particular component. - @param aComponent + @param aComponent component whose schema will be accessed - @returns + @returns an object allowing access to the various parts of the schema, <NULL/> if the component doesn't exist. @@ -79,11 +79,11 @@ published interface XSchemaSupplier : ::com::sun::star::uno::XInterface raises (BackendAccessException, com::sun::star::lang::IllegalArgumentException) ; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- } ; -//============================================================================= +//============================================================================= } ; } ; } ; } ; } ; -#endif +#endif diff --git a/offapi/com/sun/star/configuration/backend/XSingleLayerStratum.idl b/offapi/com/sun/star/configuration/backend/XSingleLayerStratum.idl index 96ac572e82db..62f7bd18d034 100644 --- a/offapi/com/sun/star/configuration/backend/XSingleLayerStratum.idl +++ b/offapi/com/sun/star/configuration/backend/XSingleLayerStratum.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -29,11 +29,11 @@ #ifndef __com_sun_star_uno_XInterface_idl__ #include <com/sun/star/uno/XInterface.idl> -#endif +#endif #ifndef __com_sun_star_configuration_backend_XLayer_idl__ #include <com/sun/star/configuration/backend/XLayer.idl> -#endif +#endif #ifndef __com_sun_star_configuration_backend_XUpdatableLayer_idl__ #include <com/sun/star/configuration/backend/XUpdatableLayer.idl> @@ -45,23 +45,23 @@ #ifndef __com_sun_star_lang_IllegalArgumentException_idl__ #include <com/sun/star/lang/IllegalArgumentException.idl> -#endif +#endif #ifndef __com_sun_star_lang_NoSupportException_idl__ #include <com/sun/star/lang/NoSupportException.idl> -#endif +#endif -//============================================================================= +//============================================================================= module com { module sun { module star { module configuration { module backend { -//============================================================================= +//============================================================================= -/** - Handles access to a stratum consisting of a single layer +/** + Handles access to a stratum consisting of a single layer in a configuration data repository - - <p> The interface provides timestamp-checking capabilities + + <p> The interface provides timestamp-checking capabilities for efficient caching. </p> @@ -71,38 +71,38 @@ module com { module sun { module star { module configuration { module backend { @since OOo 1.1.2 */ -published interface XSingleLayerStratum : ::com::sun::star::uno::XInterface +published interface XSingleLayerStratum : ::com::sun::star::uno::XInterface { - //------------------------------------------------------------------------- - - /** - retrieves the layer data for a component, if newer than indicated. - - <p> A timestamp can be provided, which is used to indicate - a point in time. The layer should be returned only if is modified - since that time. + //------------------------------------------------------------------------- + + /** + retrieves the layer data for a component, if newer than indicated. + + <p> A timestamp can be provided, which is used to indicate + a point in time. The layer should be returned only if is modified + since that time. </p> - @param aComponent + @param aComponent The name of the component to access. - @param aTimestamp + @param aTimestamp a timestamp for the layer. - - <p> An empty timestamp indicates, that the layer should be - retrieved irrespective of its modification time. + + <p> An empty timestamp indicates, that the layer should be + retrieved irrespective of its modification time. </p> - <p> The format and meaning of a timestamp depends on - the implementation. Timestamps can be obtained using + <p> The format and meaning of a timestamp depends on + the implementation. Timestamps can be obtained using <member scope="com::sun::star::util">XTimeStamped::getTimestamp()</member>. </p> - @returns - a <type>Layer</type> object providing access to the layer data, - <NULL/> if the layer is newer than indicated by the timestamp. + @returns + a <type>Layer</type> object providing access to the layer data, + <NULL/> if the layer is newer than indicated by the timestamp. @throws com::sun::star::lang::IllegalArgumentException - if the component identifier is invalid or + if the component identifier is invalid or if the timestamp is invalid. @throws com::sun::star::configuration::backend::BackendAccessException @@ -110,21 +110,21 @@ published interface XSingleLayerStratum : ::com::sun::star::uno::XInterface @see com::sun::star::util::XTimeStamped */ - XLayer getLayer([in] string aComponent, + XLayer getLayer([in] string aComponent, [in] string aTimestamp) raises (BackendAccessException, com::sun::star::lang::IllegalArgumentException) ; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- /** retrieves a writable representation of the layer for a component. - @param aComponent + @param aComponent The name of the component to access. - - @return - an <type>UpdatableLayer</type> object providing + + @return + an <type>UpdatableLayer</type> object providing write access to the layer @throws com::sun::star::lang::IllegalArgumentException @@ -140,12 +140,12 @@ published interface XSingleLayerStratum : ::com::sun::star::uno::XInterface raises (BackendAccessException, com::sun::star::lang::NoSupportException, com::sun::star::lang::IllegalArgumentException) ; - - //------------------------------------------------------------------------- + + //------------------------------------------------------------------------- } ; -//============================================================================= +//============================================================================= } ; } ; } ; } ; } ; -#endif +#endif diff --git a/offapi/com/sun/star/configuration/backend/XUpdatableLayer.idl b/offapi/com/sun/star/configuration/backend/XUpdatableLayer.idl index c2fdf99e2eb0..66bf699be203 100644 --- a/offapi/com/sun/star/configuration/backend/XUpdatableLayer.idl +++ b/offapi/com/sun/star/configuration/backend/XUpdatableLayer.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -34,11 +34,11 @@ #ifndef __com_sun_star_lang_NullPointerException_idl__ #include <com/sun/star/lang/NullPointerException.idl> -#endif +#endif #ifndef __com_sun_star_lang_WrappedTargetException_idl__ #include <com/sun/star/lang/WrappedTargetException.idl> -#endif +#endif #ifndef __com_sun_star_configuration_backend_MalformedDataException_idl__ #include <com/sun/star/configuration/backend/MalformedDataException.idl> @@ -56,7 +56,7 @@ module com { module sun { module star { module configuration { module backend { @since OOo 1.1.2 */ -published interface XUpdatableLayer : XLayer +published interface XUpdatableLayer : XLayer { //-------------------------------------------------------------------------- @@ -65,12 +65,12 @@ published interface XUpdatableLayer : XLayer parameter. <p> After the replacement has been performed, reading the - layer will return the new content. Some implementations + layer will return the new content. Some implementations may not support this, so after an update <member>XLayer::readData()</member> may fail. </p> - @param aNewLayer + @param aNewLayer replacement layer @throws com::sun::star::lang::NullPointerException @@ -80,7 +80,7 @@ published interface XUpdatableLayer : XLayer @throws com::sun::star::configuration::backend::MalformedDataException if the layer contains invalid data. */ - void replaceWith([in] XLayer aNewLayer) + void replaceWith([in] XLayer aNewLayer) raises (com::sun::star::lang::NullPointerException, com::sun::star::lang::WrappedTargetException, MalformedDataException) ; diff --git a/offapi/com/sun/star/configuration/backend/XUpdateHandler.idl b/offapi/com/sun/star/configuration/backend/XUpdateHandler.idl index 918eee7ea365..f7b7a01cbc0c 100644 --- a/offapi/com/sun/star/configuration/backend/XUpdateHandler.idl +++ b/offapi/com/sun/star/configuration/backend/XUpdateHandler.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -24,44 +24,44 @@ * for a copy of the LGPLv3 License. * ************************************************************************/ -#ifndef __com_sun_star_configuration_backend_XUpdateHandler_idl__ +#ifndef __com_sun_star_configuration_backend_XUpdateHandler_idl__ #define __com_sun_star_configuration_backend_XUpdateHandler_idl__ - -#ifndef __com_sun_star_uno_XInterface_idl__ -#include <com/sun/star/uno/XInterface.idl> -#endif - -#ifndef __com_sun_star_configuration_backend_TemplateIdentifier_idl__ -#include <com/sun/star/configuration/backend/TemplateIdentifier.idl> -#endif - -#ifndef __com_sun_star_configuration_backend_MalformedDataException_idl__ -#include <com/sun/star/configuration/backend/MalformedDataException.idl> -#endif - -#ifndef __com_sun_star_lang_WrappedTargetException_idl__ -#include <com/sun/star/lang/WrappedTargetException.idl> -#endif - -#ifndef __com_sun_star_lang_IllegalAccessException_idl__ -#include <com/sun/star/lang/IllegalAccessException.idl> -#endif + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_configuration_backend_TemplateIdentifier_idl__ +#include <com/sun/star/configuration/backend/TemplateIdentifier.idl> +#endif + +#ifndef __com_sun_star_configuration_backend_MalformedDataException_idl__ +#include <com/sun/star/configuration/backend/MalformedDataException.idl> +#endif + +#ifndef __com_sun_star_lang_WrappedTargetException_idl__ +#include <com/sun/star/lang/WrappedTargetException.idl> +#endif + +#ifndef __com_sun_star_lang_IllegalAccessException_idl__ +#include <com/sun/star/lang/IllegalAccessException.idl> +#endif //============================================================================= - + module com { module sun { module star { module configuration { module backend { - -//============================================================================= - -/** receives a description of a configuration update or layer + +//============================================================================= + +/** receives a description of a configuration update or layer as a sequence of events. @since OOo 1.1.2 */ published interface XUpdateHandler: ::com::sun::star::uno::XInterface -{ - //------------------------------------------------------------------------- - +{ + //------------------------------------------------------------------------- + /** receives notification that a update or description is started. @throws com::sun::star::configuration::backend::MalformedDataException @@ -69,19 +69,19 @@ published interface XUpdateHandler: ::com::sun::star::uno::XInterface @throws com::sun::star::lang::IllegalAccessException if the target layer is read-only - <p><em>Some implementations can only detect this when executing + <p><em>Some implementations can only detect this when executing <member>XUpdateHandler::endUpdate()</member></em> </p> @throws com::sun::star::lang::WrappedTargetException if an error occurs processing the event. */ - void startUpdate( ) + void startUpdate( ) raises( MalformedDataException, - com::sun::star::lang::IllegalAccessException, - com::sun::star::lang::WrappedTargetException ); - //------------------------------------------------------------------------- - + com::sun::star::lang::IllegalAccessException, + com::sun::star::lang::WrappedTargetException ); + //------------------------------------------------------------------------- + /** receives notification that the current update description is complete. <p> Must match a previous call to <member>XUpdateHandler::startUpdate()</member>. @@ -102,16 +102,16 @@ published interface XUpdateHandler: ::com::sun::star::uno::XInterface @throws com::sun::star::lang::WrappedTargetException if an error occurs processing the event. */ - void endUpdate( ) + void endUpdate( ) raises( MalformedDataException, - com::sun::star::lang::IllegalAccessException, - com::sun::star::lang::WrappedTargetException ); - //------------------------------------------------------------------------- - + com::sun::star::lang::IllegalAccessException, + com::sun::star::lang::WrappedTargetException ); + //------------------------------------------------------------------------- + /** receives notification that a modification of a node is started. - <p> Subsequent calls describe changes to properties and items or - members of the node until a matching call to + <p> Subsequent calls describe changes to properties and items or + members of the node until a matching call to <member>XUpdateHandler::endNode()</member> is encountered. </p> @@ -122,17 +122,17 @@ published interface XUpdateHandler: ::com::sun::star::uno::XInterface specifies attribute values to be applied to the node in the current layer. - <p> The value is a combination of + <p> The value is a combination of <type>NodeAttribute</type> flags. </p> - <p> Only attributes which are selected in aAttributeMask + <p> Only attributes which are selected in aAttributeMask are changed. </p> @param aAttributeMask specifies which attributes should be changed for the node. - <p> The value is a combination of + <p> The value is a combination of <type>NodeAttribute</type> flags. </p> @@ -143,7 +143,7 @@ published interface XUpdateHandler: ::com::sun::star::uno::XInterface @throws com::sun::star::configuration::backend::MalformedDataException <ul> - <li>if there isn't an update in progress at all</li> + <li>if there isn't an update in progress at all</li> <li>if a node is not valid in this place</li> <li>if there already was a change to that node</li> <li>if there is no node with that name</li> @@ -161,21 +161,21 @@ published interface XUpdateHandler: ::com::sun::star::uno::XInterface void modifyNode ( [in] string aName, [in] short aAttributes, [in] short aAttributeMask, - [in] boolean bReset ) + [in] boolean bReset ) raises( MalformedDataException, - com::sun::star::lang::WrappedTargetException ); - //------------------------------------------------------------------------- - + com::sun::star::lang::WrappedTargetException ); + //------------------------------------------------------------------------- + /** receives notification that a node is started as a new item. - <p> The current node must be a set and + <p> The current node must be a set and a preexisting item (if any) must be removeable. </p> <p> The new item will be created from the default template of the set. </p> <p> Subsequent calls describe the difference from the template - of properties, items or members of the node until a matching call + of properties, items or members of the node until a matching call to <member>XUpdateHandler::endNode()</member> is encountered. </p> @@ -185,7 +185,7 @@ published interface XUpdateHandler: ::com::sun::star::uno::XInterface @param aAttributes specifies attribute values to be applied to the new node. - <p> The value is a combination of + <p> The value is a combination of <type>NodeAttribute</type> flags. Note that <member>NodeAttribute::FUSE</member> has an impact on the semantics of this method. @@ -207,20 +207,20 @@ published interface XUpdateHandler: ::com::sun::star::uno::XInterface @see com::sun::star::configuration::backend::NodeAttribute */ - void addOrReplaceNode ( [in] string aName, - [in] short aAttributes ) + void addOrReplaceNode ( [in] string aName, + [in] short aAttributes ) raises( MalformedDataException, - com::sun::star::lang::WrappedTargetException ); - //------------------------------------------------------------------------- - - /** receives notification that a node is started as a new item + com::sun::star::lang::WrappedTargetException ); + //------------------------------------------------------------------------- + + /** receives notification that a node is started as a new item based on a particular template. - <p> The current node must be a set and + <p> The current node must be a set and a preexisting item (if any) must be removeable. </p> <p> Subsequent calls describe the difference from the template - of properties or members of the node until a matching call + of properties or members of the node until a matching call to <member>XUpdateHandler::endNode()</member> is encountered. </p> @@ -233,7 +233,7 @@ published interface XUpdateHandler: ::com::sun::star::uno::XInterface @param aAttributes specifies attribute values to be applied to the new node. - <p> The value is a combination of + <p> The value is a combination of <type>NodeAttribute</type> flags. Note that <member>NodeAttribute::FUSE</member> has an impact on the semantics of this method. @@ -256,39 +256,39 @@ published interface XUpdateHandler: ::com::sun::star::uno::XInterface @see com::sun::star::configuration::backend::NodeAttribute */ - void addOrReplaceNodeFromTemplate( [in] string aName, + void addOrReplaceNodeFromTemplate( [in] string aName, [in] short aAttributes, [in] TemplateIdentifier aTemplate ) raises( MalformedDataException, - com::sun::star::lang::WrappedTargetException ); - //------------------------------------------------------------------------- - + com::sun::star::lang::WrappedTargetException ); + //------------------------------------------------------------------------- + /** receives notification that a node modification is complete. - <p> Must match the last open call to - <member>XUpdateHandler::modifyNode()</member>, - <member>XUpdateHandler::addOrReplaceNode()</member> or + <p> Must match the last open call to + <member>XUpdateHandler::modifyNode()</member>, + <member>XUpdateHandler::addOrReplaceNode()</member> or <member>XUpdateHandler::addOrReplaceNodeFromTemplate()</member>. </p> @throws com::sun::star::configuration::backend::MalformedDataException <ul> <li>if invalid data is detected in the node</li> - <li>if no node is started at all</li> + <li>if no node is started at all</li> </ul> <p><em>Not every implementation can detect each condition</em></p> @throws com::sun::star::lang::WrappedTargetException if an error occurs processing the event. */ - void endNode( ) + void endNode( ) raises( MalformedDataException, - com::sun::star::lang::WrappedTargetException ); - //------------------------------------------------------------------------- - - /** receives notification that an item is to be dropped from a set. + com::sun::star::lang::WrappedTargetException ); + //------------------------------------------------------------------------- + + /** receives notification that an item is to be dropped from a set. - <p> The current node must be a set and + <p> The current node must be a set and the item must be removeable. </p> @@ -308,15 +308,15 @@ published interface XUpdateHandler: ::com::sun::star::uno::XInterface @throws com::sun::star::lang::WrappedTargetException if an error occurs processing the event. */ - void removeNode( [in] string aName ) + void removeNode( [in] string aName ) raises( MalformedDataException, - com::sun::star::lang::WrappedTargetException ); - //------------------------------------------------------------------------- - + com::sun::star::lang::WrappedTargetException ); + //------------------------------------------------------------------------- + /** receives notification that modification of an existing property is started. . - <p> Subsequent calls describe changes to the value(s) - of the property until a matching call to + <p> Subsequent calls describe changes to the value(s) + of the property until a matching call to <member>XUpdateHandler::endProperty()</member> is encountered. </p> @@ -326,20 +326,20 @@ published interface XUpdateHandler: ::com::sun::star::uno::XInterface @param aAttributes specifies new attributes of the property. - <p> The value is a combination of + <p> The value is a combination of <type>NodeAttribute</type> flags. </p> - <p> Only attributes which are selected in aAttributeMask are changed. + <p> Only attributes which are selected in aAttributeMask are changed. </p> - <p> <const>NodeAttribute::MANDATORY</const> need not be set - and can't be removed, as dynamic properties always are mandatory + <p> <const>NodeAttribute::MANDATORY</const> need not be set + and can't be removed, as dynamic properties always are mandatory in subsequent layers. </p> @param aAttributeMask specifies which attributes should be changed for the property. - <p> The value is a combination of + <p> The value is a combination of <type>NodeAttribute</type> flags. </p> @@ -366,22 +366,22 @@ published interface XUpdateHandler: ::com::sun::star::uno::XInterface @see com::sun::star::configuration::backend::NodeAttribute */ - void modifyProperty( [in] string aName, - [in] short aAttributes, - [in] short aAttributeMask, - [in] type aType ) + void modifyProperty( [in] string aName, + [in] short aAttributes, + [in] short aAttributeMask, + [in] type aType ) raises( MalformedDataException, - com::sun::star::lang::WrappedTargetException ); - //------------------------------------------------------------------------- - - /** receives notification about a change to the value of + com::sun::star::lang::WrappedTargetException ); + //------------------------------------------------------------------------- + + /** receives notification about a change to the value of the current property. @param aValue specifies the new value of the property. - <p> The value must match the type of the existing property. - If the property does not have the + <p> The value must match the type of the existing property. + If the property does not have the <const>SchemaAttribute::REQUIRED</const> flag set, the value can be <void/>. </p> @@ -390,7 +390,7 @@ published interface XUpdateHandler: ::com::sun::star::uno::XInterface <ul> <li>if there isn't a property modification in progress currently</li> <li>if there already was a change to this value</li> - <li>if the type of the value is not an allowed type</li> + <li>if the type of the value is not an allowed type</li> <li>if the value is not valid for the property</li> </ul> <p><em>Not every implementation can detect each condition</em></p> @@ -400,19 +400,19 @@ published interface XUpdateHandler: ::com::sun::star::uno::XInterface @see com::sun::star::configuration::backend::NodeAttribute */ - void setPropertyValue( [in] any aValue ) + void setPropertyValue( [in] any aValue ) raises( MalformedDataException, - com::sun::star::lang::WrappedTargetException ); - //------------------------------------------------------------------------- - - /** receives notification about a change to the value of + com::sun::star::lang::WrappedTargetException ); + //------------------------------------------------------------------------- + + /** receives notification about a change to the value of the current property for a specific locale. @param aValue specifies the new value of the property for the given locale. - <p> The value must match the type of the existing property. - If the property does not have the + <p> The value must match the type of the existing property. + If the property does not have the <const>SchemaAttribute::REQUIRED</const> flag set, the value can be <void/>. </p> @@ -422,7 +422,7 @@ published interface XUpdateHandler: ::com::sun::star::uno::XInterface @throws com::sun::star::configuration::backend::MalformedDataException <ul> - <li>if there isn't a property modification in progress currently</li> + <li>if there isn't a property modification in progress currently</li> <li>if the property is not localizable</li> <li>if there already was a change to this value</li> <li>if the type of the value is not an allowed type</li> @@ -436,12 +436,12 @@ published interface XUpdateHandler: ::com::sun::star::uno::XInterface @see com::sun::star::configuration::backend::NodeAttribute */ - void setPropertyValueForLocale( [in] any aValue, [in] string aLocale ) + void setPropertyValueForLocale( [in] any aValue, [in] string aLocale ) raises( MalformedDataException, - com::sun::star::lang::WrappedTargetException ); - //------------------------------------------------------------------------- - - /** receives notification that the value of the current property + com::sun::star::lang::WrappedTargetException ); + //------------------------------------------------------------------------- + + /** receives notification that the value of the current property should be reset to its default. @throws com::sun::star::configuration::backend::MalformedDataException @@ -456,12 +456,12 @@ published interface XUpdateHandler: ::com::sun::star::uno::XInterface @see com::sun::star::configuration::backend::NodeAttribute */ - void resetPropertyValue( ) + void resetPropertyValue( ) raises( MalformedDataException, - com::sun::star::lang::WrappedTargetException ); - //------------------------------------------------------------------------- - - /** receives notification that the value of the current property + com::sun::star::lang::WrappedTargetException ); + //------------------------------------------------------------------------- + + /** receives notification that the value of the current property for a specific locale should be reset to its default. @param aLocale @@ -481,33 +481,33 @@ published interface XUpdateHandler: ::com::sun::star::uno::XInterface @see com::sun::star::configuration::backend::NodeAttribute */ - void resetPropertyValueForLocale( [in] string aLocale ) + void resetPropertyValueForLocale( [in] string aLocale ) raises( MalformedDataException, - com::sun::star::lang::WrappedTargetException ); - //------------------------------------------------------------------------- - + com::sun::star::lang::WrappedTargetException ); + //------------------------------------------------------------------------- + /** receives notification that a property modification is complete. - <p> Must match the last open call to + <p> Must match the last open call to <member>XUpdateHandler::modifyProperty()</member>. </p> @throws com::sun::star::configuration::backend::MalformedDataException <ul> <li>if invalid data is detected in the property</li> - <li>if no property is started at all</li> + <li>if no property is started at all</li> </ul> <p><em>Not every implementation can detect each condition</em></p> @throws com::sun::star::lang::WrappedTargetException if an error occurs processing the event. */ - void endProperty( ) + void endProperty( ) raises( MalformedDataException, - com::sun::star::lang::WrappedTargetException ); - //------------------------------------------------------------------------- - - /** receives notification that a property is reset to its default state. + com::sun::star::lang::WrappedTargetException ); + //------------------------------------------------------------------------- + + /** receives notification that a property is reset to its default state. @param aName specifies the name of the property. @@ -516,7 +516,7 @@ published interface XUpdateHandler: ::com::sun::star::uno::XInterface <ul> <li>if there isn't a group or extensible node in progress currently</li> <li>if there already was a change to a property of that name</li> - <li>if there is no property with that name, or if the property + <li>if there is no property with that name, or if the property has no default</li> <li>if the property is read-only</li> <li>if the name is not a valid property name</li> @@ -528,16 +528,16 @@ published interface XUpdateHandler: ::com::sun::star::uno::XInterface @see com::sun::star::configuration::backend::NodeAttribute */ - void resetProperty( [in] string aName ) + void resetProperty( [in] string aName ) raises( MalformedDataException, - com::sun::star::lang::WrappedTargetException ); - //------------------------------------------------------------------------- - + com::sun::star::lang::WrappedTargetException ); + //------------------------------------------------------------------------- + /** receives notification that a property having a value of <void/> - is added to the current node. + is added to the current node. - <p> The current node must be extensible and - a preexisting property (if any) must be + <p> The current node must be extensible and + a preexisting property (if any) must be removeable in this layer. </p> @@ -547,13 +547,13 @@ published interface XUpdateHandler: ::com::sun::star::uno::XInterface @param aAttributes specifies the attributes of the new property. - <p> The value is a combination of - <type>NodeAttribute</type> flags and may also contain the + <p> The value is a combination of + <type>NodeAttribute</type> flags and may also contain the <const>SchemaAttribute::REQUIRED</const> flag. </p> </p> - <p> <const>NodeAttribute::MANDATORY</const> need not be set, - as dynamic properties always are mandatory + <p> <const>NodeAttribute::MANDATORY</const> need not be set, + as dynamic properties always are mandatory in subsequent layers. </p> @@ -566,7 +566,7 @@ published interface XUpdateHandler: ::com::sun::star::uno::XInterface <li>if there already was a change to a property of that name</li> <li>if a property of that name exists and is not removeable</li> <li>if the specified type is not allowed</li> - <li>if the name is not a valid property name</li> + <li>if the name is not a valid property name</li> <li>if the attributes are not valid for the property</li> </ul> <p><em>Not every implementation can detect each condition</em></p> @@ -576,18 +576,18 @@ published interface XUpdateHandler: ::com::sun::star::uno::XInterface @see com::sun::star::configuration::backend::SchemaAttribute */ - void addOrReplaceProperty( [in] string aName, - [in] short aAttributes, - [in] type aType ) + void addOrReplaceProperty( [in] string aName, + [in] short aAttributes, + [in] type aType ) raises( MalformedDataException, - com::sun::star::lang::WrappedTargetException ); - //------------------------------------------------------------------------- - - /** receives notification that a property having a non-<NULL/> value - is added to the current node. - - <p> The current node must be extensible and - a preexisting property (if any) must be + com::sun::star::lang::WrappedTargetException ); + //------------------------------------------------------------------------- + + /** receives notification that a property having a non-<NULL/> value + is added to the current node. + + <p> The current node must be extensible and + a preexisting property (if any) must be removeable in this layer. </p> @@ -597,20 +597,20 @@ published interface XUpdateHandler: ::com::sun::star::uno::XInterface @param aAttributes specifies the attributes of the new property. - <p> The value is a combination of - <type>NodeAttribute</type> flags and may also contain the + <p> The value is a combination of + <type>NodeAttribute</type> flags and may also contain the <const>SchemaAttribute::REQUIRED</const> flag. </p> </p> - <p> <const>NodeAttribute::MANDATORY</const> need not be set, - as dynamic properties always are mandatory + <p> <const>NodeAttribute::MANDATORY</const> need not be set, + as dynamic properties always are mandatory in subsequent layers. </p> @param aValue specifies the value of the new property. - <p> The value also determines the type. + <p> The value also determines the type. Therefore the value must not be <void/>. </p> @@ -631,14 +631,14 @@ published interface XUpdateHandler: ::com::sun::star::uno::XInterface @see com::sun::star::configuration::backend::SchemaAttribute */ - void addOrReplacePropertyWithValue( [in] string aName, - [in] short aAttributes, - [in] any aValue ) + void addOrReplacePropertyWithValue( [in] string aName, + [in] short aAttributes, + [in] any aValue ) raises( MalformedDataException, - com::sun::star::lang::WrappedTargetException ); - //------------------------------------------------------------------------- - - /** receives notification that a property is dropped from the current node. + com::sun::star::lang::WrappedTargetException ); + //------------------------------------------------------------------------- + + /** receives notification that a property is dropped from the current node. <p>The current node must be extensible and the property removeable.</p> @@ -657,17 +657,17 @@ published interface XUpdateHandler: ::com::sun::star::uno::XInterface @throws com::sun::star::lang::WrappedTargetException if an error occurs processing the event. */ - void removeProperty( [in] string aName ) + void removeProperty( [in] string aName ) raises( MalformedDataException, - com::sun::star::lang::WrappedTargetException ); - //------------------------------------------------------------------------- - -}; - -//============================================================================= - -}; }; }; }; }; - -//============================================================================= - -#endif + com::sun::star::lang::WrappedTargetException ); + //------------------------------------------------------------------------- + +}; + +//============================================================================= + +}; }; }; }; }; + +//============================================================================= + +#endif diff --git a/offapi/com/sun/star/configuration/backend/XVersionedSchemaSupplier.idl b/offapi/com/sun/star/configuration/backend/XVersionedSchemaSupplier.idl index 2bcefd070ac3..845d8ba4414d 100644 --- a/offapi/com/sun/star/configuration/backend/XVersionedSchemaSupplier.idl +++ b/offapi/com/sun/star/configuration/backend/XVersionedSchemaSupplier.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -29,7 +29,7 @@ #ifndef __com_sun_star_configuration_backend_XSchemaSupplier_idl__ #include <com/sun/star/configuration/backend/XSchemaSupplier.idl> -#endif +#endif #ifndef __com_sun_star_configuration_backend_BackendAccessException_idl__ #include <com/sun/star/configuration/backend/BackendAccessException.idl> @@ -37,43 +37,43 @@ #ifndef __com_sun_star_lang_IllegalArgumentException_idl__ #include <com/sun/star/lang/IllegalArgumentException.idl> -#endif +#endif -//============================================================================= +//============================================================================= module com { module sun { module star { module configuration { module backend { -//============================================================================= +//============================================================================= -/** +/** provides access to versioned configuration component schemas. @since OOo 2.0 */ -interface XVersionedSchemaSupplier : XSchemaSupplier +interface XVersionedSchemaSupplier : XSchemaSupplier { - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- /** Returns the schema version for a particular component. - @param aComponent + @param aComponent component whose schema version will be determined - @returns - a <atom>string</atom> that identifies the schema version for + @returns + a <atom>string</atom> that identifies the schema version for the given component. - <p> The format of the version string is arbitrary. No meaning - should be attached to it, unless an implementing service - defines one. If no version can be determined, an empty + <p> The format of the version string is arbitrary. No meaning + should be attached to it, unless an implementing service + defines one. If no version can be determined, an empty <atom>string</atom> may be returned. </p> - <p> Clients may assume that all instances of a schema with the + <p> Clients may assume that all instances of a schema with the same version are identical. The converse is not true. - In particular an implementation may return the same version - string for all schemas it supplies (i.e. return a version for + In particular an implementation may return the same version + string for all schemas it supplies (i.e. return a version for the complete schema, including all components) </p> @@ -87,11 +87,11 @@ interface XVersionedSchemaSupplier : XSchemaSupplier raises (BackendAccessException, com::sun::star::lang::IllegalArgumentException) ; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- } ; -//============================================================================= +//============================================================================= } ; } ; } ; } ; } ; -#endif +#endif diff --git a/offapi/com/sun/star/configuration/backend/xml/LayerParser.idl b/offapi/com/sun/star/configuration/backend/xml/LayerParser.idl index 864051bae236..9f60e22074a5 100644 --- a/offapi/com/sun/star/configuration/backend/xml/LayerParser.idl +++ b/offapi/com/sun/star/configuration/backend/xml/LayerParser.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -29,70 +29,70 @@ #ifndef __com_sun_star_configuration_backend_XLayer_idl__ #include <com/sun/star/configuration/backend/XLayer.idl> -#endif +#endif #ifndef __com_sun_star_io_XActiveDataSink_idl__ #include <com/sun/star/io/XActiveDataSink.idl> -#endif +#endif #ifndef __com_sun_star_lang_XInitialization_idl__ #include <com/sun/star/lang/XInitialization.idl> -#endif +#endif -//============================================================================= +//============================================================================= module com { module sun { module star { module configuration { module backend { module xml { -//============================================================================= +//============================================================================= /** represents a configuration data layer that is stored in a stream in OOR Update XML format. - <p> The configuration layer xml from a given stream is parsed and fed to a - <type scope="com::sun::star::configuration::backend">XLayerHandler</type>. + <p> The configuration layer xml from a given stream is parsed and fed to a + <type scope="com::sun::star::configuration::backend">XLayerHandler</type>. </p> - + @see com::sun::star::configuration::backend::xml::SchemaParser Service that represents a configuration schema stored in xml. @see com::sun::star::configuration::backend::xml::LayerWriter - Service that writes OOR Update XML for data described via - <type scope="com::sun::star::configuration::backend">XLayerHandler</type>. + Service that writes OOR Update XML for data described via + <type scope="com::sun::star::configuration::backend">XLayerHandler</type>. @since OOo 1.1.2 */ published service LayerParser { - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- /** provides access to the parsed layer data. */ interface com::sun::star::configuration::backend::XLayer ; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- /** provides access to the source xml stream. */ interface com::sun::star::io::XActiveDataSink ; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- /** allows initializing the source stream. - <p> The source can be passed - as a <type scope="com::sun::star::io">XInputStream</type> or + <p> The source can be passed + as a <type scope="com::sun::star::io">XInputStream</type> or as a <type scope="com::sun::star::xml::sax">InputSource</type>. - </p> + </p> */ interface com::sun::star::lang::XInitialization ; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- } ; -//============================================================================= +//============================================================================= } ; -} ; } ; } ; } ; } ; +} ; } ; } ; } ; } ; -#endif +#endif diff --git a/offapi/com/sun/star/configuration/backend/xml/LayerWriter.idl b/offapi/com/sun/star/configuration/backend/xml/LayerWriter.idl index 1a32587ad13a..1a05e2f6f9a5 100644 --- a/offapi/com/sun/star/configuration/backend/xml/LayerWriter.idl +++ b/offapi/com/sun/star/configuration/backend/xml/LayerWriter.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -29,31 +29,31 @@ #ifndef __com_sun_star_lang_XInitialization_idl__ #include <com/sun/star/lang/XInitialization.idl> -#endif +#endif #ifndef __com_sun_star_io_XActiveDataSource_idl__ #include <com/sun/star/io/XActiveDataSource.idl> -#endif +#endif #ifndef __com_sun_star_configuration_backend_XLayerHandler_idl__ #include <com/sun/star/configuration/backend/XLayerHandler.idl> -#endif +#endif -//============================================================================= +//============================================================================= module com { module sun { module star { module configuration { module backend { module xml { -//============================================================================= +//============================================================================= /** can be used to parse a stream of configuration layer xml. - <p> The configuration layer data described to a + <p> The configuration layer data described to a <type scope="com::sun::star::configuration::backend">XLayerHandler</type> is written to a stream as OOR Update XML. </p> - + @see com::sun::star::configuration::backend::xml::LayerParser Service that parses configuration layer xml. @@ -61,33 +61,33 @@ module xml { */ published service LayerWriter { - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- /** accepts events describing the layer data. */ interface com::sun::star::configuration::backend::XLayerHandler ; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- /** provides access to the target stream. */ interface com::sun::star::io::XActiveDataSource ; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- /** allows initializing target stream. - <p> The target can be passed + <p> The target can be passed as a <type scope="com::sun::star::io">XOutputStream</type>. - </p> + </p> */ interface com::sun::star::lang::XInitialization ; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- } ; -//============================================================================= +//============================================================================= } ; -} ; } ; } ; } ; } ; +} ; } ; } ; } ; } ; -#endif +#endif diff --git a/offapi/com/sun/star/configuration/backend/xml/SchemaParser.idl b/offapi/com/sun/star/configuration/backend/xml/SchemaParser.idl index 6c60fa2a338a..73c5710ac788 100644 --- a/offapi/com/sun/star/configuration/backend/xml/SchemaParser.idl +++ b/offapi/com/sun/star/configuration/backend/xml/SchemaParser.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -29,30 +29,30 @@ #ifndef __com_sun_star_configuration_backend_XSchema_idl__ #include <com/sun/star/configuration/backend/XSchema.idl> -#endif +#endif #ifndef __com_sun_star_io_XActiveDataSink_idl__ #include <com/sun/star/io/XActiveDataSink.idl> -#endif +#endif #ifndef __com_sun_star_lang_XInitialization_idl__ #include <com/sun/star/lang/XInitialization.idl> -#endif +#endif -//============================================================================= +//============================================================================= module com { module sun { module star { module configuration { module backend { module xml { -//============================================================================= +//============================================================================= /** represents a configuration schema that is stored in a stream in OOR Schema XML format. - <p> The configuration schema xml from a given stream is parsed and fed to a - <type scope="com::sun::star::configuration::backend">XSchemaHandler</type>. + <p> The configuration schema xml from a given stream is parsed and fed to a + <type scope="com::sun::star::configuration::backend">XSchemaHandler</type>. </p> - + @see com::sun::star::configuration::backend::xml::LayerParser Service that parses configuration layer xml. @@ -60,34 +60,34 @@ module xml { */ published service SchemaParser { - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- /** provides access to the parsed schema data. */ interface com::sun::star::configuration::backend::XSchema ; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- /** provides access to the source xml stream. */ interface com::sun::star::io::XActiveDataSink ; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- /** allows initializing the source stream. - <p> The source can be passed - as a <type scope="com::sun::star::io">XInputStream</type> or + <p> The source can be passed + as a <type scope="com::sun::star::io">XInputStream</type> or as a <type scope="com::sun::star::xml::sax">InputSource</type>. - </p> + </p> */ interface com::sun::star::lang::XInitialization ; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- } ; -//============================================================================= +//============================================================================= } ; -} ; } ; } ; } ; } ; +} ; } ; } ; } ; } ; -#endif +#endif diff --git a/offapi/com/sun/star/configuration/bootstrap/BootstrapContext.idl b/offapi/com/sun/star/configuration/bootstrap/BootstrapContext.idl index 3441b45e73a1..9b987448c758 100644 --- a/offapi/com/sun/star/configuration/bootstrap/BootstrapContext.idl +++ b/offapi/com/sun/star/configuration/bootstrap/BootstrapContext.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -29,48 +29,48 @@ #ifndef __com_sun_star_uno_XComponentContext_idl__ #include <com/sun/star/uno/XComponentContext.idl> -#endif +#endif -//============================================================================= +//============================================================================= module com { module sun { module star { module configuration { module bootstrap { -//============================================================================= +//============================================================================= /** - provides access to a component context that is enhanced with - bootstrap parameters for configuration services from the + provides access to a component context that is enhanced with + bootstrap parameters for configuration services from the associated metaconfiguration mechanism. - <p> The contained settings are used to initialize the + <p> The contained settings are used to initialize the <type scope="com::sun::star::configuration">DefaultProvider</type> and - <type scope="com::sun::star::configuration::backend">DefaultBackend</type> of the - component context. + <type scope="com::sun::star::configuration::backend">DefaultBackend</type> of the + component context. </p> - <p> The implementation is usally available as singleton in the context - that it wraps.. + <p> The implementation is usally available as singleton in the context + that it wraps.. </p> - + @since OOo 1.1.2 */ -published service BootstrapContext +published service BootstrapContext { - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- /** provides access to metaconfiguration data. - <p>Some values are retrieved from external metaconfiguration, + <p>Some values are retrieved from external metaconfiguration, if they are not overridden in the wrapped context. - </p> + </p> */ interface com::sun::star::uno::XComponentContext ; - //------------------------------------------------------------------------- + //------------------------------------------------------------------------- } ; -//============================================================================= +//============================================================================= -} ; } ; } ; } ; } ; +} ; } ; } ; } ; } ; -#endif +#endif |