offapi/com/sun/star/sdbc/SQLException.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  module com {  module sun {  module star {  module sdbc {
  21
  22
  23 /** is an exception that provides information on a database access error.
  24
  25     <p>
  26     Each
  27     com::sun::star::sdbc::SQLException
  28     provides several kinds of information:
  29     </p>
  30     <p>
  31     <ul>
  32     <li>
  33     a string describing the error.  This is used as the
  34     com::sun::star::uno::Exception
  35     message.
  36     </li>
  37     </ul>
  38     </p>
  39  */
  40 published exception SQLException: com::sun::star::uno::Exception
  41 {
  42     /** returns a string, which uses the XOPEN SQLState conventions.
  43         The values of the SQLState string are described in the XOPEN SQL spec.
  44      */
  45     string          SQLState;
  46
  47     /** returns an integer error code that is specific to each vendor.  Normally this will
  48         be the actual error code returned by the underlying database.
  49      */
  50     long            ErrorCode;
  51
  52     /** returns a chain to the next Exception.
  53         This can be used to provide additional
  54         error information.
  55      */
  56     any             NextException;
  57 };
  58
  59
  60 }; }; }; };
  61
  62 /*===========================================================================
  63 ===========================================================================*/
  64
  65 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */