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