1*d1766043SAndrew Rist/************************************************************** 2cdf0e10cSrcweir * 3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4*d1766043SAndrew Rist * or more contributor license agreements. See the NOTICE file 5*d1766043SAndrew Rist * distributed with this work for additional information 6*d1766043SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the 8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance 9*d1766043SAndrew Rist * with the License. You may obtain a copy of the License at 10*d1766043SAndrew Rist * 11*d1766043SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12*d1766043SAndrew Rist * 13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing, 14*d1766043SAndrew Rist * software distributed under the License is distributed on an 15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*d1766043SAndrew Rist * KIND, either express or implied. See the License for the 17*d1766043SAndrew Rist * specific language governing permissions and limitations 18*d1766043SAndrew Rist * under the License. 19*d1766043SAndrew Rist * 20*d1766043SAndrew Rist *************************************************************/ 21*d1766043SAndrew Rist 22*d1766043SAndrew Rist 23cdf0e10cSrcweir#ifndef __com_sun_star_ucb_HierarchyDataReadWriteAccess_idl__ 24cdf0e10cSrcweir#define __com_sun_star_ucb_HierarchyDataReadWriteAccess_idl__ 25cdf0e10cSrcweir 26cdf0e10cSrcweir#ifndef __com_sun_star_ucb_HierarchyDataReadAccess_idl__ 27cdf0e10cSrcweir#include <com/sun/star/ucb/HierarchyDataReadAccess.idl> 28cdf0e10cSrcweir#endif 29cdf0e10cSrcweir#ifndef __com_sun_star_container_XNameContainer_idl__ 30cdf0e10cSrcweir#include <com/sun/star/container/XNameContainer.idl> 31cdf0e10cSrcweir#endif 32cdf0e10cSrcweir#ifndef __com_sun_star_lang_XSingleServiceFactory_idl__ 33cdf0e10cSrcweir#include <com/sun/star/lang/XSingleServiceFactory.idl> 34cdf0e10cSrcweir#endif 35cdf0e10cSrcweir#ifndef __com_sun_star_util_XChangesBatch_idl__ 36cdf0e10cSrcweir#include <com/sun/star/util/XChangesBatch.idl> 37cdf0e10cSrcweir#endif 38cdf0e10cSrcweir 39cdf0e10cSrcweir//============================================================================= 40cdf0e10cSrcweir 41cdf0e10cSrcweirmodule com { module sun { module star { module ucb { 42cdf0e10cSrcweir 43cdf0e10cSrcweir//============================================================================= 44cdf0e10cSrcweir/** provides read and write access to a fragment of the hierarchy data. 45cdf0e10cSrcweir*/ 46cdf0e10cSrcweirpublished service HierarchyDataReadWriteAccess 47cdf0e10cSrcweir{ 48cdf0e10cSrcweir //------------------------------------------------------------------------- 49cdf0e10cSrcweir /** provides read access to a fragment of the hierarchy data 50cdf0e10cSrcweir */ 51cdf0e10cSrcweir service HierarchyDataReadAccess; 52cdf0e10cSrcweir 53cdf0e10cSrcweir //------------------------------------------------------------------------- 54cdf0e10cSrcweir /** allows adding and removing of hierarchy data nodes, replacing of 55cdf0e10cSrcweir the value of hierarchy data node members, as well as obtaining the 56cdf0e10cSrcweir value of hieryrchy data node members. 57cdf0e10cSrcweir 58cdf0e10cSrcweir <p>Adding and removing must only be supported if the access object 59cdf0e10cSrcweir points to the "Children" data member of a node or to the root node. 60cdf0e10cSrcweir It will insert a new node or or remove an existing one. If supported 61cdf0e10cSrcweir on data nodes, adding must add new data members to the node, removing 62cdf0e10cSrcweir must remove data members. However, the mandatory data members (Title, 63cdf0e10cSrcweir TargetURL, Children) must never be removable. 64cdf0e10cSrcweir 65cdf0e10cSrcweir <p>Replacing and getting values must be supported be every data node. 66cdf0e10cSrcweir */ 67cdf0e10cSrcweir interface com::sun::star::container::XNameContainer; 68cdf0e10cSrcweir 69cdf0e10cSrcweir //------------------------------------------------------------------------- 70cdf0e10cSrcweir /** gives access to all contents provided by this provider. 71cdf0e10cSrcweir 72cdf0e10cSrcweir <p><member scope="com::sun::star::lang">XSingleServiceFactory::createInstance</member> 73cdf0e10cSrcweir will create a new empty hierarchy data node. After it was created 74cdf0e10cSrcweir it's data members can be filled. Last, the node can be inserted as child 75cdf0e10cSrcweir of another node using 76cdf0e10cSrcweir <member scope="com::sun::star::container">XNameContainer::insertByName</member>. 77cdf0e10cSrcweir 78cdf0e10cSrcweir <p>There are no special arguments that must be supported by 79cdf0e10cSrcweir <member scope="com::sun::star::lang">XSingleServiceFactory::createInstanceWithArguments</member> 80cdf0e10cSrcweir */ 81cdf0e10cSrcweir interface com::sun::star::lang::XSingleServiceFactory; 82cdf0e10cSrcweir 83cdf0e10cSrcweir //------------------------------------------------------------------------- 84cdf0e10cSrcweir /** allows managing changes within the hierarchy. 85cdf0e10cSrcweir 86cdf0e10cSrcweir <p><member scope="com::sun::star::util">XChangesBatch::getPendingChanges</member> 87cdf0e10cSrcweir reports all changes within the hierarchy that are done through (direct 88cdf0e10cSrcweir or indirect) descendants of this element. The same set of changes is 89cdf0e10cSrcweir committed to persistent storage and/or made visible to other objects 90cdf0e10cSrcweir accessing the same data set, when 91cdf0e10cSrcweir <member scope="com::sun::star::util">XChangesBatch::commitChanges</member> 92cdf0e10cSrcweir is invoked. 93cdf0e10cSrcweir */ 94cdf0e10cSrcweir interface com::sun::star::util::XChangesBatch; 95cdf0e10cSrcweir}; 96cdf0e10cSrcweir 97cdf0e10cSrcweir//============================================================================= 98cdf0e10cSrcweir 99cdf0e10cSrcweir}; }; }; }; 100cdf0e10cSrcweir 101cdf0e10cSrcweir#endif 102