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
24#ifndef __com_sun_star_ucb_NameClashResolveRequest_idl__
25#define __com_sun_star_ucb_NameClashResolveRequest_idl__
26
27#ifndef __com_sun_star_task_ClassifiedInteractionRequest_idl__
28#include <com/sun/star/task/ClassifiedInteractionRequest.idl>
29#endif
30
31
32//=============================================================================
33
34module com { module sun { module star { module ucb {
35
36//=============================================================================
37/** This request is used to indicate a name clash.
38
39    <p>For example, when copying a file there migth be another file in the
40    target folder that has the same file name as the source file.
41
42    <p>If this exception is passed to an
43    <type scope="com::sun::star::task">XInteractionHandler</type> an
44    <type>XInteractionSupplyName</type> and an
45    <type>XInteractionReplaceExistingData</type> should be supplied with
46    the <type scope="com::sun::star::task">XInteractionRequest</type>. On
47    return the <type>XInteractionSupplyName</type>, if selected, will contain
48    a new name supposed to resolve the name clash. The
49    <type>XInteractionReplaceExistingData</type> will be selected if the
50    clashing resource shall be overwritten.
51
52	@version	1.0
53	@author 	Kai Sommerfeld
54*/
55published exception NameClashResolveRequest : com::sun::star::task::ClassifiedInteractionRequest
56{
57	//-------------------------------------------------------------------------
58    /** contains the URL of the folder that contains the clashing resource.
59     */
60    string TargetFolderURL;
61
62	//-------------------------------------------------------------------------
63    /** contains the clashing name.
64     */
65    string ClashingName;
66
67	//-------------------------------------------------------------------------
68    /** contains a proposal for a new new, non-clashing name.
69        <p>This field may be left empty if the implementation is not able
70        to suggest a new name.
71     */
72    string ProposedNewName;
73};
74
75//=============================================================================
76
77}; }; }; };
78
79#endif
80