summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/ucb/HierarchyDataReadWriteAccess.idl
diff options
context:
space:
mode:
Diffstat (limited to 'offapi/com/sun/star/ucb/HierarchyDataReadWriteAccess.idl')
-rw-r--r--offapi/com/sun/star/ucb/HierarchyDataReadWriteAccess.idl84
1 files changed, 84 insertions, 0 deletions
diff --git a/offapi/com/sun/star/ucb/HierarchyDataReadWriteAccess.idl b/offapi/com/sun/star/ucb/HierarchyDataReadWriteAccess.idl
new file mode 100644
index 000000000..ba0336632
--- /dev/null
+++ b/offapi/com/sun/star/ucb/HierarchyDataReadWriteAccess.idl
@@ -0,0 +1,84 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef __com_sun_star_ucb_HierarchyDataReadWriteAccess_idl__
+#define __com_sun_star_ucb_HierarchyDataReadWriteAccess_idl__
+
+#include <com/sun/star/ucb/HierarchyDataReadAccess.idl>
+#include <com/sun/star/container/XNameContainer.idl>
+#include <com/sun/star/lang/XSingleServiceFactory.idl>
+#include <com/sun/star/util/XChangesBatch.idl>
+
+
+module com { module sun { module star { module ucb {
+
+/** provides read and write access to a fragment of the hierarchy data.
+*/
+published service HierarchyDataReadWriteAccess
+{
+ /** provides read access to a fragment of the hierarchy data
+ */
+ service HierarchyDataReadAccess;
+
+ /** allows adding and removing of hierarchy data nodes, replacing of
+ the value of hierarchy data node members, as well as obtaining the
+ value of hierarchy data node members.
+
+ <p>Adding and removing must only be supported if the access object
+ points to the "Children" data member of a node or to the root node.
+ It will insert a new node or remove an existing one. If supported
+ on data nodes, adding must add new data members to the node, removing
+ must remove data members. However, the mandatory data members (Title,
+ TargetURL, Children) must never be removable.
+
+ <p>Replacing and getting values must be supported be every data node.
+ */
+ interface com::sun::star::container::XNameContainer;
+
+ /** gives access to all contents provided by this provider.
+
+ <p>com::sun::star::lang::XSingleServiceFactory::createInstance()
+ will create a new empty hierarchy data node. After it was created
+ it's data members can be filled. Last, the node can be inserted as child
+ of another node using
+ com::sun::star::container::XNameContainer::insertByName().
+
+ <p>There are no special arguments that must be supported by
+ com::sun::star::lang::XSingleServiceFactory::createInstanceWithArguments()
+ */
+ interface com::sun::star::lang::XSingleServiceFactory;
+
+ /** allows managing changes within the hierarchy.
+
+ <p>com::sun::star::util::XChangesBatch::getPendingChanges()
+ 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
+ com::sun::star::util::XChangesBatch::commitChanges()
+ is invoked.
+ */
+ interface com::sun::star::util::XChangesBatch;
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */