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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27
  28 #ifndef __com_sun_star_ucb_UnsupportedNameClashException_idl__
  29 #define __com_sun_star_ucb_UnsupportedNameClashException_idl__
  30
  31 #ifndef __com_sun_star_uno_Exception_idl__
  32 #include <com/sun/star/uno/Exception.idl>
  33 #endif
  34
  35 //=============================================================================
  36
  37 module com { module sun { module star { module ucb {
  38
  39 //=============================================================================
  40 /** <p>This exception must be thrown in case the requested nameclash
  41     directive is not supported, because it is not possible to implement
  42     it or if it is just not (yet) implemented.
  43
  44     <p>Command 'transfer': Used if the nameclash directive specified in
  45     parameter NameClash of the supplied <type>TransferInfo</type> is not
  46     supported. For example, if the NameClash was set to NameClash::ERROR,
  47     to NameClash::RENAME or to NameClash::ASK, the implementation must be
  48     able determine whether there are existing data. This exception must also
  49     be used if NameClash::RENAME was specified and the implementation is
  50     unable to create a valid new name after a suitable number of tries.
  51
  52     <p>Command 'insert': Used if the parameter ReplaceExisting of the
  53     supplied <type>InsertCommandArgument</type> was set to <false/> and the
  54     implementation is unable to determine whether there are existing data.
  55     The member NameClash of the exception must be set to NameClash::ERROR
  56
  57     @version    1.0
  58     @author     Kai Sommerfeld
  59     @see        Content
  60 */
  61 published exception UnsupportedNameClashException : com::sun::star::uno::Exception
  62 {
  63     //-------------------------------------------------------------------------
  64     /** contains the <type>NameClash</type> that is not supported.
  65      */
  66     long NameClash;
  67 };
  68
  69 //=============================================================================
  70
  71 }; }; }; };
  72
  73 #endif