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#ifndef __com_sun_star_ucb_GlobalTransferCommandArgument_idl__
24#define __com_sun_star_ucb_GlobalTransferCommandArgument_idl__
25
26#ifndef __com_sun_star_ucb_TransferCommandOperation_idl__
27#include <com/sun/star/ucb/TransferCommandOperation.idl>
28#endif
29
30//=============================================================================
31
32module com { module sun { module star { module ucb {
33
34//=============================================================================
35/** This struct contains information needed to transfer objects from one
36	location to another.
37*/
38published struct GlobalTransferCommandArgument
39{
40	//-------------------------------------------------------------------------
41	/** contains the action to perform ( COPY, MOVE, LINK ).
42	  */
43	TransferCommandOperation Operation;
44
45	//-------------------------------------------------------------------------
46	/** contains the URL of the source object.
47	  */
48	string SourceURL;
49
50	//-------------------------------------------------------------------------
51	/** contains the URL of the target folder.
52	  */
53	string TargetURL;
54
55	//-------------------------------------------------------------------------
56	/** contains the title of the transferred object, if it is different
57	    from the original one.
58
59	    <p>If this field is filled, for example, a file will be renamed
60	    while it is being transferred.
61	  */
62	string NewTitle;
63
64	//-------------------------------------------------------------------------
65	/** describes how to act in case of title clashes while transferring
66	    the data.
67
68		<p>A title clash for instance occurs, if a file named "foo.txt" is
69		to be transferred to a folder already containing another file named
70		"foo.txt". Refer to <type>NameClash</type> for possible values for
71		this field.
72	*/
73	long NameClash;
74};
75
76//=============================================================================
77
78}; }; }; };
79
80#endif
81