summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/configuration/backend/LayerUpdateMerger.idl
diff options
context:
space:
mode:
Diffstat (limited to 'offapi/com/sun/star/configuration/backend/LayerUpdateMerger.idl')
-rw-r--r--offapi/com/sun/star/configuration/backend/LayerUpdateMerger.idl101
1 files changed, 101 insertions, 0 deletions
diff --git a/offapi/com/sun/star/configuration/backend/LayerUpdateMerger.idl b/offapi/com/sun/star/configuration/backend/LayerUpdateMerger.idl
new file mode 100644
index 000000000000..bff3c26c92a8
--- /dev/null
+++ b/offapi/com/sun/star/configuration/backend/LayerUpdateMerger.idl
@@ -0,0 +1,101 @@
+/*************************************************************************
+ *
+ * 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
+ *
+ * This file is part of OpenOffice.org.
+ *
+ * OpenOffice.org is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License version 3
+ * only, as published by the Free Software Foundation.
+ *
+ * OpenOffice.org is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Lesser General Public License version 3 for more details
+ * (a copy is included in the LICENSE file that accompanied this code).
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * version 3 along with OpenOffice.org. If not, see
+ * <http://www.openoffice.org/license.html>
+ * for a copy of the LGPLv3 License.
+ *
+ ************************************************************************/
+#ifndef __com_sun_star_configuration_backend_LayerUpdateMerger_idl__
+#define __com_sun_star_configuration_backend_LayerUpdateMerger_idl__
+
+#ifndef __com_sun_star_lang_XInitialization_idl__
+#include <com/sun/star/lang/XInitialization.idl>
+#endif
+
+#ifndef __com_sun_star_configuration_backend_XUpdateHandler_idl__
+#include <com/sun/star/configuration/backend/XUpdateHandler.idl>
+#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
+ described to a <type>XLayerHandler</type>.
+ </p>
+
+ @see com::sun::star::configuration::backend::UpdatableLayer
+ Service describes a layer and accepts a changed layer..
+
+ @since OOo 1.1.2
+*/
+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
+ provided individually by providing a <type>XLayer</type> object as
+ 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>.
+ Implementations should support the following named arguments:
+ <dl>
+ <dt><code>Overwrite</code> : <atom>boolean</atom></dt>
+ <dd>If <FALSE/>, specifies that changes should be applied
+ 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
+ to a layer that is completely empty.
+ </dd>
+ </dl>
+ </p>
+ */
+ interface com::sun::star::lang::XInitialization ;
+
+ //-------------------------------------------------------------------------
+} ;
+
+//=============================================================================
+
+} ; } ; } ; } ; } ;
+
+#endif