/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: GlobalTransferCommandArgument.idl,v $
 *
 *  $Revision: 1.3 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-08 07:28:34 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 by Sun Microsystems, Inc.
 *    901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License version 2.1, as published by the Free Software Foundation.
 *
 *    This library is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *    Lesser General Public License for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with this library; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *    MA  02111-1307  USA
 *
 ************************************************************************/
#ifndef __com_sun_star_ucb_GlobalTransferCommandArgument_idl__
#define __com_sun_star_ucb_GlobalTransferCommandArgument_idl__

#ifndef __com_sun_star_ucb_TransferCommandOperation_idl__
#include <com/sun/star/ucb/TransferCommandOperation.idl>
#endif

//=============================================================================

module com { module sun { module star { module ucb {

//=============================================================================
/** This struct contains information needed to transfer objects from one
    location to another.
*/
published struct GlobalTransferCommandArgument
{
    //-------------------------------------------------------------------------
    /** contains the action to perform ( COPY, MOVE, LINK ).
      */
    TransferCommandOperation Operation;

    //-------------------------------------------------------------------------
    /** contains the URL of the source object.
      */
    string SourceURL;

    //-------------------------------------------------------------------------
    /** contains the URL of the target folder.
      */
    string TargetURL;

    //-------------------------------------------------------------------------
    /** contains the title of the transferred object, if it is different
        from the original one.

        <p>If this field is filled, for example, a file will be renamed
        while it is being transferred.
      */
    string NewTitle;

    //-------------------------------------------------------------------------
    /** describes how to act in case of title clashes while transferring
        the data.

        <p>A title clash for instance occurs, if a file named "foo.txt" is
        to be transferred to a folder already containing another file named
        "foo.txt". Refer to <type>NameClash</type> for possible values for
        this field.
    */
    long NameClash;
};

//=============================================================================

}; }; }; };

#endif
