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