offapi/com/sun/star/resource/XStringResourceWithLocation.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: XStringResourceWithLocation.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_resource_XStringResourceWithLocation_idl__
  31 #define __com_sun_star_resource_XStringResourceWithLocation_idl__
  32
  33 #ifndef __com_sun_star_resource_XStringResourcePersistence_idl__
  34 #include <com/sun/star/resource/XStringResourcePersistence.idl>
  35 #endif
  36
  37
  38 //=============================================================================
  39
  40 module com { module sun { module star { module resource {
  41
  42 //=============================================================================
  43 /**
  44     Extends <type>XStringResourcePersistence</type> by methods to handle an
  45     associated location.
  46
  47     @see <type>XStringResourcePersistence</type>.
  48 */
  49 interface XStringResourceWithLocation: com::sun::star::resource::XStringResourcePersistence
  50 {
  51     /**
  52         Stores all string table data to a location and associates this location
  53         to this instance as if <member>setLocation</member> was called with this
  54         location. The modified state will be unmodified after the call.
  55
  56         @param URL
  57             the location the string table data should be stored to.
  58     */
  59     void storeAsURL( [in] string URL )
  60         raises( com::sun::star::uno::Exception );
  61
  62
  63     /**
  64         Associates a location to the StringResourceWithStorage instance
  65         which is used on subsequent calls of <member>store</member>.
  66
  67         @param URL
  68             the location to be associated to the StringResourceManager
  69
  70         <p>
  71         This call has to be used carefully as it removes the location
  72         previously connected to the StringResourceWithStorage. It may
  73         force the implementation to reload data from the previous
  74         location before releasing it. The StringResourceManager will
  75         be modified after calling this method as the data isn't stored
  76         to the new location yet. <member>storeAsURL</member> should
  77         be prefered as it directly stores the data to the new location
  78         and afterwards this location is in sync with the resource data.
  79         </p>
  80
  81         @throws <type scope="com::sun::star::lang">IllegalArgumentException</type>
  82             if an empty string is passed as URL
  83     */
  84     void setURL( [in] string URL )
  85         raises( ::com::sun::star::lang::IllegalArgumentException );
  86 };
  87
  88 //=============================================================================
  89
  90 }; }; }; };
  91
  92 #endif