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