1*d1766043SAndrew Rist/************************************************************** 2cdf0e10cSrcweir * 3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4*d1766043SAndrew Rist * or more contributor license agreements. See the NOTICE file 5*d1766043SAndrew Rist * distributed with this work for additional information 6*d1766043SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the 8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance 9*d1766043SAndrew Rist * with the License. You may obtain a copy of the License at 10*d1766043SAndrew Rist * 11*d1766043SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12*d1766043SAndrew Rist * 13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing, 14*d1766043SAndrew Rist * software distributed under the License is distributed on an 15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*d1766043SAndrew Rist * KIND, either express or implied. See the License for the 17*d1766043SAndrew Rist * specific language governing permissions and limitations 18*d1766043SAndrew Rist * under the License. 19*d1766043SAndrew Rist * 20*d1766043SAndrew Rist *************************************************************/ 21*d1766043SAndrew Rist 22*d1766043SAndrew Rist 23cdf0e10cSrcweir#ifndef __com_sun_star_ucb_TransferInfo_idl__ 24cdf0e10cSrcweir#define __com_sun_star_ucb_TransferInfo_idl__ 25cdf0e10cSrcweir 26cdf0e10cSrcweir 27cdf0e10cSrcweir//============================================================================= 28cdf0e10cSrcweir 29cdf0e10cSrcweirmodule com { module sun { module star { module ucb { 30cdf0e10cSrcweir 31cdf0e10cSrcweir//============================================================================= 32cdf0e10cSrcweir/** contains information needed to transfer objects from one location to another. 33cdf0e10cSrcweir 34cdf0e10cSrcweir <p>The transfer command is always called on the target folder. For a 35cdf0e10cSrcweir details description of the transfer command refer to the documentation 36cdf0e10cSrcweir of service <type>Content</type>. 37cdf0e10cSrcweir*/ 38cdf0e10cSrcweirpublished struct TransferInfo 39cdf0e10cSrcweir{ 40cdf0e10cSrcweir //------------------------------------------------------------------------- 41cdf0e10cSrcweir /** contains the flags describing whether the data shall be moved 42cdf0e10cSrcweir instead of copied. 43cdf0e10cSrcweir */ 44cdf0e10cSrcweir boolean MoveData; 45cdf0e10cSrcweir 46cdf0e10cSrcweir //------------------------------------------------------------------------- 47cdf0e10cSrcweir /** contains the URL of the source of the action (e.g. the URL of a 48cdf0e10cSrcweir file to move). 49cdf0e10cSrcweir */ 50cdf0e10cSrcweir string SourceURL; 51cdf0e10cSrcweir 52cdf0e10cSrcweir //------------------------------------------------------------------------- 53cdf0e10cSrcweir /** contains the title of the transferred object, if it is different 54cdf0e10cSrcweir from the original one. 55cdf0e10cSrcweir 56cdf0e10cSrcweir <p>If this field is filled, for example, a file will be renamed 57cdf0e10cSrcweir while it is being transferred.</p> 58cdf0e10cSrcweir */ 59cdf0e10cSrcweir string NewTitle; 60cdf0e10cSrcweir 61cdf0e10cSrcweir //------------------------------------------------------------------------- 62cdf0e10cSrcweir /** describes how to act in case of title clashes while transferring 63cdf0e10cSrcweir the data. 64cdf0e10cSrcweir 65cdf0e10cSrcweir <p>A title clash for instance occurs, if a file named "foo.txt" is 66cdf0e10cSrcweir to be transferred to a folder already containing another file named 67cdf0e10cSrcweir "foo.txt". 68cdf0e10cSrcweir 69cdf0e10cSrcweir <p>The value can be one of the <type>NameClash</type> constants. 70cdf0e10cSrcweir 71cdf0e10cSrcweir <p>Implementations that are not able to detect whether there is a 72cdf0e10cSrcweir clashing resource may ignore <member>NameClash::ERROR</member> and 73cdf0e10cSrcweir <member>NameClash::RENAME</member> always write the new data. 74cdf0e10cSrcweir */ 75cdf0e10cSrcweir long NameClash; 76cdf0e10cSrcweir 77cdf0e10cSrcweir}; 78cdf0e10cSrcweir 79cdf0e10cSrcweir//============================================================================= 80cdf0e10cSrcweir 81cdf0e10cSrcweir}; }; }; }; 82cdf0e10cSrcweir 83cdf0e10cSrcweir#endif 84