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 28*cdf0e10cSrcweir#ifndef __com_sun_star_embed_FileSystemStorage_idl__ 29*cdf0e10cSrcweir#define __com_sun_star_embed_FileSystemStorage_idl__ 30*cdf0e10cSrcweir 31*cdf0e10cSrcweir#ifndef __com_sun_star_embed_BaseStorage_idl__ 32*cdf0e10cSrcweir#include <com/sun/star/embed/BaseStorage.idl> 33*cdf0e10cSrcweir#endif 34*cdf0e10cSrcweir 35*cdf0e10cSrcweir//============================================================================ 36*cdf0e10cSrcweir 37*cdf0e10cSrcweir module com { module sun { module star { module embed { 38*cdf0e10cSrcweir 39*cdf0e10cSrcweir//============================================================================ 40*cdf0e10cSrcweir/** This is a service that allows to get access to a file system folder using 41*cdf0e10cSrcweir storage hierarchy. 42*cdf0e10cSrcweir */ 43*cdf0e10cSrcweirpublished service FileSystemStorage 44*cdf0e10cSrcweir{ 45*cdf0e10cSrcweir // ----------------------------------------------------------------------- 46*cdf0e10cSrcweir /** This service describes the base functionality of storages. 47*cdf0e10cSrcweir 48*cdf0e10cSrcweir <p> 49*cdf0e10cSrcweir Please see below the description of additional requirements for the 50*cdf0e10cSrcweir file system storage implementation. 51*cdf0e10cSrcweir </p> 52*cdf0e10cSrcweir 53*cdf0e10cSrcweir <dl> 54*cdf0e10cSrcweir <dt>interface <type scope="com::sun::star::lang">XComponent</type> 55*cdf0e10cSrcweir </dt> 56*cdf0e10cSrcweir <dd> 57*cdf0e10cSrcweir <p> 58*cdf0e10cSrcweir A file system storage is created either by 59*cdf0e10cSrcweir <type>StorageFactory</type> or by <type>XStorage</type> 60*cdf0e10cSrcweir interface and is controlled by refcounting. In case 61*cdf0e10cSrcweir refcounting is decreased to zero the storage will be 62*cdf0e10cSrcweir disposed automatically. 63*cdf0e10cSrcweir </p> 64*cdf0e10cSrcweir 65*cdf0e10cSrcweir <p> 66*cdf0e10cSrcweir In case a storage object is disposed the elements 67*cdf0e10cSrcweir ( substorages and substreams ) are not affected. 68*cdf0e10cSrcweir </p> 69*cdf0e10cSrcweir </dd> 70*cdf0e10cSrcweir <dt>interface <type>XStorage</type></dt> 71*cdf0e10cSrcweir <dd> 72*cdf0e10cSrcweir <dl> 73*cdf0e10cSrcweir <dt><method>XStorage::openStorageElement</method></dt> 74*cdf0e10cSrcweir <dd> 75*cdf0e10cSrcweir This method returns <type>FileSystemStorage</type> 76*cdf0e10cSrcweir service implementation. 77*cdf0e10cSrcweir </dd> 78*cdf0e10cSrcweir 79*cdf0e10cSrcweir <dt><method>XStorage::copyLastCommitTo</method></dt> 80*cdf0e10cSrcweir <dd> 81*cdf0e10cSrcweir Since this service implementation supports no transaction 82*cdf0e10cSrcweir this method just creates a copy of the storage in it's 83*cdf0e10cSrcweir current state. 84*cdf0e10cSrcweir </dd> 85*cdf0e10cSrcweir 86*cdf0e10cSrcweir <dt><method>XStorage::copyStorageElementLastCommitTo</method></dt> 87*cdf0e10cSrcweir <dd> 88*cdf0e10cSrcweir Since this service implementation supports no transaction 89*cdf0e10cSrcweir this method just creates a copy of the storage in it's 90*cdf0e10cSrcweir current state. 91*cdf0e10cSrcweir </dd> 92*cdf0e10cSrcweir 93*cdf0e10cSrcweir <dt><method>XStorage::removeStorageElement</method></dt> 94*cdf0e10cSrcweir <dd> 95*cdf0e10cSrcweir If the element is opened and it is a stream element 96*cdf0e10cSrcweir the removing will fail. If the element is opened and 97*cdf0e10cSrcweir it is a storage element, all the contents that can be 98*cdf0e10cSrcweir removed will be removed. 99*cdf0e10cSrcweir </dd> 100*cdf0e10cSrcweir </dl> 101*cdf0e10cSrcweir </dd> 102*cdf0e10cSrcweir <dt>property URL</dt> 103*cdf0e10cSrcweir <dd> 104*cdf0e10cSrcweir This property is not optional for this service. 105*cdf0e10cSrcweir </dd> 106*cdf0e10cSrcweir </dl> 107*cdf0e10cSrcweir 108*cdf0e10cSrcweir */ 109*cdf0e10cSrcweir service BaseStorage; 110*cdf0e10cSrcweir}; 111*cdf0e10cSrcweir 112*cdf0e10cSrcweir//============================================================================ 113*cdf0e10cSrcweir 114*cdf0e10cSrcweir}; }; }; }; 115*cdf0e10cSrcweir 116*cdf0e10cSrcweir#endif 117*cdf0e10cSrcweir 118