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