offapi/com/sun/star/ucb/TransferInfo.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: TransferInfo.idl,v $
  10  * $Revision: 1.10 $
  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 #ifndef __com_sun_star_ucb_TransferInfo_idl__
  31 #define __com_sun_star_ucb_TransferInfo_idl__
  32
  33
  34 //=============================================================================
  35
  36 module com { module sun { module star { module ucb {
  37
  38 //=============================================================================
  39 /** contains information needed to transfer objects from one location to another.
  40
  41     <p>The transfer command is always called on the target folder. For a
  42     details description of the transfer command refer to the documentation
  43     of service <type>Content</type>.
  44 */
  45 published struct TransferInfo
  46 {
  47     //-------------------------------------------------------------------------
  48     /** contains the flags describing whether the data shall be moved
  49         instead of copied.
  50     */
  51     boolean MoveData;
  52
  53     //-------------------------------------------------------------------------
  54     /** contains the URL of the source of the action (e.g. the URL of a
  55         file to move).
  56     */
  57     string SourceURL;
  58
  59     //-------------------------------------------------------------------------
  60     /** contains the title of the transferred object, if it is different
  61         from the original one.
  62
  63         <p>If this field is filled, for example, a file will be renamed
  64         while it is being transferred.</p>
  65     */
  66     string NewTitle;
  67
  68     //-------------------------------------------------------------------------
  69     /** describes how to act in case of title clashes while transferring
  70         the data.
  71
  72         <p>A title clash for instance occurs, if a file named "foo.txt" is
  73         to be transferred to a folder already containing another file named
  74         "foo.txt".
  75
  76         <p>The value can be one of the <type>NameClash</type> constants.
  77
  78         <p>Implementations that are not able to detect whether there is a
  79         clashing resource may ignore <member>NameClash::ERROR</member> and
  80         <member>NameClash::RENAME</member> always write the new data.
  81     */
  82     long NameClash;
  83
  84 };
  85
  86 //=============================================================================
  87
  88 }; }; }; };
  89
  90 #endif