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

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