1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27
28#ifndef __com_sun_star_ucb_NameClashResolveRequest_idl__
29#define __com_sun_star_ucb_NameClashResolveRequest_idl__
30
31#ifndef __com_sun_star_task_ClassifiedInteractionRequest_idl__
32#include <com/sun/star/task/ClassifiedInteractionRequest.idl>
33#endif
34
35
36//=============================================================================
37
38module com { module sun { module star { module ucb {
39
40//=============================================================================
41/** This request is used to indicate a name clash.
42
43    <p>For example, when copying a file there migth be another file in the
44    target folder that has the same file name as the source file.
45
46    <p>If this exception is passed to an
47    <type scope="com::sun::star::task">XInteractionHandler</type> an
48    <type>XInteractionSupplyName</type> and an
49    <type>XInteractionReplaceExistingData</type> should be supplied with
50    the <type scope="com::sun::star::task">XInteractionRequest</type>. On
51    return the <type>XInteractionSupplyName</type>, if selected, will contain
52    a new name supposed to resolve the name clash. The
53    <type>XInteractionReplaceExistingData</type> will be selected if the
54    clashing resource shall be overwritten.
55
56	@version	1.0
57	@author 	Kai Sommerfeld
58*/
59published exception NameClashResolveRequest : com::sun::star::task::ClassifiedInteractionRequest
60{
61	//-------------------------------------------------------------------------
62    /** contains the URL of the folder that contains the clashing resource.
63     */
64    string TargetFolderURL;
65
66	//-------------------------------------------------------------------------
67    /** contains the clashing name.
68     */
69    string ClashingName;
70
71	//-------------------------------------------------------------------------
72    /** contains a proposal for a new new, non-clashing name.
73        <p>This field may be left empty if the implementation is not able
74        to suggest a new name.
75     */
76    string ProposedNewName;
77};
78
79//=============================================================================
80
81}; }; }; };
82
83#endif
84