offapi/com/sun/star/ucb/HierarchyDataReadWriteAccess.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_ucb_HierarchyDataReadWriteAccess_idl__
  28 #define __com_sun_star_ucb_HierarchyDataReadWriteAccess_idl__
  29
  30 #ifndef __com_sun_star_ucb_HierarchyDataReadAccess_idl__
  31 #include <com/sun/star/ucb/HierarchyDataReadAccess.idl>
  32 #endif
  33 #ifndef __com_sun_star_container_XNameContainer_idl__
  34 #include <com/sun/star/container/XNameContainer.idl>
  35 #endif
  36 #ifndef __com_sun_star_lang_XSingleServiceFactory_idl__
  37 #include <com/sun/star/lang/XSingleServiceFactory.idl>
  38 #endif
  39 #ifndef __com_sun_star_util_XChangesBatch_idl__
  40 #include <com/sun/star/util/XChangesBatch.idl>
  41 #endif
  42
  43 //=============================================================================
  44
  45 module com { module sun { module star { module ucb {
  46
  47 //=============================================================================
  48 /** provides read and write access to a fragment of the hierarchy data.
  49 */
  50 published service HierarchyDataReadWriteAccess
  51 {
  52     //-------------------------------------------------------------------------
  53     /** provides read access to a fragment of the hierarchy data
  54      */
  55     service HierarchyDataReadAccess;
  56
  57     //-------------------------------------------------------------------------
  58     /** allows adding and removing of hierarchy data nodes, replacing of
  59         the value of hierarchy data node members, as well as obtaining the
  60         value of hieryrchy data node members.
  61
  62         <p>Adding and removing must only be supported if the access object
  63         points to the "Children" data member of a node or to the root node.
  64         It will insert a new node or or remove an existing one. If supported
  65         on data nodes, adding must add new data members to the node, removing
  66         must remove data members. However, the mandatory data members (Title,
  67         TargetURL, Children) must never be removable.
  68
  69         <p>Replacing and getting values must be supported be every data node.
  70      */
  71     interface com::sun::star::container::XNameContainer;
  72
  73     //-------------------------------------------------------------------------
  74     /** gives access to all contents provided by this provider.
  75
  76         <p><member scope="com::sun::star::lang">XSingleServiceFactory::createInstance</member>
  77         will create a new empty hierarchy data node. After it was created
  78         it's data members can be filled. Last, the node can be inserted as child
  79         of another node using
  80         <member scope="com::sun::star::container">XNameContainer::insertByName</member>.
  81
  82         <p>There are no special arguments that must be supported by
  83         <member scope="com::sun::star::lang">XSingleServiceFactory::createInstanceWithArguments</member>
  84      */
  85     interface com::sun::star::lang::XSingleServiceFactory;
  86
  87     //-------------------------------------------------------------------------
  88     /** allows managing changes within the hierarchy.
  89
  90         <p><member scope="com::sun::star::util">XChangesBatch::getPendingChanges</member>
  91         reports all changes within the hierarchy that are done through (direct
  92         or indirect) descendants of this element. The same set of changes is
  93         committed to persistent storage and/or made visible to other objects
  94         accessing the same data set, when
  95         <member scope="com::sun::star::util">XChangesBatch::commitChanges</member>
  96         is invoked.
  97      */
  98     interface com::sun::star::util::XChangesBatch;
  99 };
 100
 101 //=============================================================================
 102
 103 }; }; }; };
 104
 105 #endif