offapi/com/sun/star/frame/XStorable2.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: XStorable2.idl,v $
  10  * $Revision: 1.4 $
  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_frame_XStorable2_idl__
  31 #define __com_sun_star_frame_XStorable2_idl__
  32
  33 #ifndef __com_sun_star_frame_XStorable_idl__
  34 #include <com/sun/star/frame/XStorable.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  38 #include <com/sun/star/lang/IllegalArgumentException.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_io_IOException_idl__
  42 #include <com/sun/star/io/IOException.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_beans_PropertyValue_idl__
  46 #include <com/sun/star/beans/PropertyValue.idl>
  47 #endif
  48
  49
  50 //=============================================================================
  51
  52  module com {  module sun {  module star {  module frame {
  53
  54 //=============================================================================
  55 /** extends <type>XStorable</type>.
  56  */
  57 published interface XStorable2: XStorable
  58 {
  59     /** stores the data to the URL from which it was loaded.
  60
  61         <p>
  62             Only objects which know their locations can be stored.
  63         </p>
  64
  65         <p>
  66             This is an extention of the <method>XStorable::store()</method>.
  67             This method allows to specify some additional parametes for
  68             storing process.
  69         </p>
  70
  71         @param lArguments
  72             optional parameters for saving, can take values from subset of
  73             <type scope="com::sun::star::document">MediaDescriptor</type>
  74
  75         @thrown ::com::sun::star::lang::IllegalArgumentException
  76             the optional parameters contain unacceptable for save entry
  77
  78         @throws com::sun::star::io::IOException
  79             if an IO error occured during save operation
  80
  81         @see XStorable::store
  82      */
  83     void storeSelf(
  84         [in] sequence<com::sun::star::beans::PropertyValue> lArguments )
  85             raises( com::sun::star::lang::IllegalArgumentException,
  86                     com::sun::star::io::IOException );
  87
  88 };
  89
  90 //=============================================================================
  91
  92 }; }; }; };
  93
  94 #endif
  95