xref: /trunk/main/offapi/com/sun/star/ucb/NameClashResolveRequest.idl (revision ffd38472365e95f6a578737bc9a5eb0fac624a86)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/



#ifndef __com_sun_star_ucb_NameClashResolveRequest_idl__
#define __com_sun_star_ucb_NameClashResolveRequest_idl__

#ifndef __com_sun_star_task_ClassifiedInteractionRequest_idl__
#include <com/sun/star/task/ClassifiedInteractionRequest.idl>
#endif


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

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

//=============================================================================
/** This request is used to indicate a name clash.

    <p>For example, when copying a file there migth be another file in the
    target folder that has the same file name as the source file.

    <p>If this exception is passed to an
    <type scope="com::sun::star::task">XInteractionHandler</type> an
    <type>XInteractionSupplyName</type> and an
    <type>XInteractionReplaceExistingData</type> should be supplied with
    the <type scope="com::sun::star::task">XInteractionRequest</type>. On
    return the <type>XInteractionSupplyName</type>, if selected, will contain
    a new name supposed to resolve the name clash. The
    <type>XInteractionReplaceExistingData</type> will be selected if the
    clashing resource shall be overwritten.

    @version    1.0
    @author     Kai Sommerfeld
*/
published exception NameClashResolveRequest : com::sun::star::task::ClassifiedInteractionRequest
{
    //-------------------------------------------------------------------------
    /** contains the URL of the folder that contains the clashing resource.
     */
    string TargetFolderURL;

    //-------------------------------------------------------------------------
    /** contains the clashing name.
     */
    string ClashingName;

    //-------------------------------------------------------------------------
    /** contains a proposal for a new new, non-clashing name.
        <p>This field may be left empty if the implementation is not able
        to suggest a new name.
     */
    string ProposedNewName;
};

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

}; }; }; };

#endif