offapi/com/sun/star/sdbcx/XDrop.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 sdbcx {
  21
  22 /** provides methods to remove an element of its container and to drop it from
  23     the related database.
  24  */
  25 published interface XDrop: com::sun::star::uno::XInterface
  26 {
  27
  28     /** drops an object of the related container identified by its name.
  29         @param elementName
  30             the name of the element to be dropped
  31         @throws com::sun::star::sdbc::SQLException
  32             if a database access error occurs.
  33      */
  34     void dropByName([in]string elementName) raises
  35     (com::sun::star::sdbc::SQLException,
  36         com::sun::star::container::NoSuchElementException);
  37
  38     /** drops an object of the related container identified by its position.
  39         @param index
  40             the position of the element to be dropped
  41         @throws com::sun::star::sdbc::SQLException
  42             if a database access error occurs.
  43      */
  44     void dropByIndex([in]long index) raises (com::sun::star::sdbc::SQLException,
  45         com::sun::star::lang::IndexOutOfBoundsException);
  46 };
  47
  48
  49 }; }; }; };
  50
  51 /*===========================================================================
  52 ===========================================================================*/
  53
  54 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */