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