offapi/com/sun/star/ucb/UnsupportedNameClashException.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_ucb_UnsupportedNameClashException_idl__
  21 #define __com_sun_star_ucb_UnsupportedNameClashException_idl__
  22
  23 #include <com/sun/star/uno/Exception.idl>
  24
  25
  26 module com { module sun { module star { module ucb {
  27
  28 /** <p>This exception must be thrown in case the requested name clash
  29     directive is not supported, because it is not possible to implement
  30     it or if it is just not (yet) implemented.
  31
  32     <p>Command "transfer": Used if the name clash directive specified in
  33     parameter NameClash of the supplied TransferInfo is not
  34     supported. For example, if the NameClash was set to NameClash::ERROR,
  35     to NameClash::RENAME or to NameClash::ASK, the implementation must be
  36     able determine whether there are existing data. This exception must also
  37     be used if NameClash::RENAME was specified and the implementation is
  38     unable to create a valid new name after a suitable number of tries.
  39
  40     <p>Command "insert": Used if the parameter ReplaceExisting of the
  41     supplied InsertCommandArgument was set to `FALSE` and the
  42     implementation is unable to determine whether there are existing data.
  43     The member NameClash of the exception must be set to NameClash::ERROR
  44
  45     @version    1.0
  46     @author     Kai Sommerfeld
  47     @see        Content
  48 */
  49 published exception UnsupportedNameClashException : com::sun::star::uno::Exception
  50 {
  51     /** contains the NameClash that is not supported.
  52      */
  53     long NameClash;
  54 };
  55
  56
  57 }; }; }; };
  58
  59 #endif
  60
  61 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */