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