offapi/com/sun/star/sdb/DocumentSaveRequest.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: DocumentSaveRequest.idl,v $
  10  * $Revision: 1.5 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_sdb_DocumentSaveRequest_idl__
  31 #define __com_sun_star_sdb_DocumentSaveRequest_idl__
  32
  33 #ifndef __com_sun_star_task_ClassifiedInteractionRequest_idl__
  34 #include <com/sun/star/task/ClassifiedInteractionRequest.idl>
  35 #endif
  36 #ifndef __com_sun_star_ucb_XContent_idl__
  37 #include <com/sun/star/ucb/XContent.idl>
  38 #endif
  39
  40 //=============================================================================
  41
  42  module com {  module sun {  module star {  module sdb {
  43
  44 //=============================================================================
  45
  46 /** an error specifying the lack of a document name
  47     <p>
  48     Usually thrown if someone tries to save a document which hasn't a name yet.
  49     </p>
  50     @since OOo 2.0.0
  51 */
  52 exception DocumentSaveRequest: com::sun::star::task::ClassifiedInteractionRequest
  53 {
  54     /** specifies the content where the document should save inside.
  55         Somebody handling the request could, e.g., use the content as root content
  56         to display the hierarchy of the sub contents.
  57     */
  58     com::sun::star::ucb::XContent Content;
  59
  60     /** The default name of the document, may be empty.
  61      */
  62     string Name;
  63 };
  64
  65 //=============================================================================
  66
  67 }; }; }; };
  68
  69 /*=============================================================================
  70
  71 =============================================================================*/
  72 #endif
  73