offapi/com/sun/star/sdbc/SQLException.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 #ifndef __com_sun_star_sdbc_SQLException_idl__
  28 #define __com_sun_star_sdbc_SQLException_idl__
  29
  30 #ifndef __com_sun_star_uno_Exception_idl__
  31 #include <com/sun/star/uno/Exception.idl>
  32 #endif
  33
  34  module com {  module sun {  module star {  module sdbc {
  35
  36
  37 /** is an exception that provides information on a database access error.
  38
  39     <p>
  40     Each
  41     <type scope="com::sun::star::sdbc">SQLException</type>
  42     provides several kinds of information:
  43     </p>
  44     <p>
  45     <ul>
  46     <li>
  47     a string describing the error.  This is used as the
  48     <type scope="com::sun::star::uno">Exception</type>
  49     message.
  50     </li>
  51     </ul>
  52     </p>
  53  */
  54 published exception SQLException: com::sun::star::uno::Exception
  55 {
  56     /** returns a string, which uses the XOPEN SQLState conventions.
  57         The values of the SQLState string are described in the XOPEN SQL spec.
  58      */
  59     string          SQLState;
  60
  61     /** returns an integer error code that is specific to each vendor.  Normally this will
  62         be the actual error code returned by the underlying database.
  63         A chain to the next Exception.  This can be used to provide additional
  64         error information.
  65      */
  66     long            ErrorCode;
  67
  68     /** returns a chain to the next Exception.
  69         This can be used to provide additional
  70         error information.
  71      */
  72     any             NextException;
  73 };
  74
  75 //=============================================================================
  76
  77 }; }; }; };
  78
  79 /*===========================================================================
  80 ===========================================================================*/
  81 #endif