/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   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 .
 */

#ifndef __com_sun_star_ucb_NameClashResolveRequest_idl__
#define __com_sun_star_ucb_NameClashResolveRequest_idl__

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



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 might 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
    com::sun::star::task::XInteractionHandler an
    XInteractionSupplyName and an
    XInteractionReplaceExistingData should be supplied with
    the com::sun::star::task::XInteractionRequest. On
    return the XInteractionSupplyName, if selected, will contain
    a new name supposed to resolve the name clash. The
    XInteractionReplaceExistingData will be selected if the
    clashing resource shall be overwritten.

    @version    1.0
*/
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, non-clashing name.
        <p>This field may be left empty if the implementation is not able
        to suggest a new name.
     */
    string ProposedNewName;
};


}; }; }; };

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
