1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_resource_XStringResourceWithLocation_idl__
24#define __com_sun_star_resource_XStringResourceWithLocation_idl__
25
26#ifndef __com_sun_star_resource_XStringResourcePersistence_idl__
27#include <com/sun/star/resource/XStringResourcePersistence.idl>
28#endif
29
30
31//=============================================================================
32
33module com { module sun { module star { module resource {
34
35//=============================================================================
36/**
37    Extends <type>XStringResourcePersistence</type> by methods to handle an
38    associated location.
39
40    @see <type>XStringResourcePersistence</type>.
41*/
42published interface XStringResourceWithLocation: com::sun::star::resource::XStringResourcePersistence
43{
44    /**
45        Stores all string table data to a location and associates this location
46        to this instance as if <member>setLocation</member> was called with this
47        location. The modified state will be unmodified after the call.
48
49        @param URL
50            the location the string table data should be stored to.
51    */
52    void storeAsURL( [in] string URL )
53        raises( com::sun::star::uno::Exception );
54
55
56    /**
57        Associates a location to the StringResourceWithStorage instance
58        which is used on subsequent calls of <member>store</member>.
59
60        @param URL
61            the location to be associated to the StringResourceManager
62
63        <p>
64        This call has to be used carefully as it removes the location
65        previously connected to the StringResourceWithStorage. It may
66        force the implementation to reload data from the previous
67        location before releasing it. The StringResourceManager will
68        be modified after calling this method as the data isn't stored
69        to the new location yet. <member>storeAsURL</member> should
70        be prefered as it directly stores the data to the new location
71        and afterwards this location is in sync with the resource data.
72        </p>
73
74        @throws <type scope="com::sun::star::lang">IllegalArgumentException</type>
75            if an empty string is passed as URL
76    */
77    void setURL( [in] string URL )
78        raises( ::com::sun::star::lang::IllegalArgumentException );
79};
80
81//=============================================================================
82
83}; }; }; };
84
85#endif
86