offapi/com/sun/star/embed/XEmbedObjectCreator.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: XEmbedObjectCreator.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_embed_XEmbedObjectCreator_idl__
  31 #define __com_sun_star_embed_XEmbedObjectCreator_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_embed_XStorage_idl__
  38 #include <com/sun/star/embed/XStorage.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_embed_WrongStateException_idl__
  46 #include <com/sun/star/embed/WrongStateException.idl>
  47 #endif
  48
  49 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  50 #include <com/sun/star/lang/IllegalArgumentException.idl>
  51 #endif
  52
  53 #ifndef __com_sun_star_beans_PropertyValue_idl__
  54 #include <com/sun/star/beans/PropertyValue.idl>
  55 #endif
  56
  57 //============================================================================
  58
  59  module com {  module sun {  module star {  module embed {
  60
  61 //============================================================================
  62 /** allows to create and initialize a new embedded object.
  63
  64     <p>
  65     This interface contains methods that can help to create and initialize
  66     an embedded object.
  67     </p>
  68  */
  69 interface XEmbedObjectCreator: com::sun::star::uno::XInterface
  70 {
  71     // -----------------------------------------------------------------------
  72     /** creates a new object and initializes it as a new one.
  73
  74         <p> In case specified entry exists it's contents are ignored and
  75         will be overwritten on storing.
  76         </p>
  77
  78         @param aClassID
  79             the class id of the new object
  80
  81         @param sClassName
  82             the class name of the new object
  83
  84         @param xStorage
  85             a parent storage the entry should be created/opened in
  86
  87         @param sEntryName
  88             a name for the entry
  89
  90         @param aObjectArgs
  91             optional parameters for the object persistence initialization
  92             see also
  93             <type>EmbeddedObjectDescriptor</type>
  94
  95         @throws ::com::sun::star::lang::IllegalArgumentException
  96             one of arguments is illegal
  97
  98         @throws com::sun::star::io::IOException
  99             in case of io problems during opening\creation
 100
 101         @throws com::sun::star::uno::Exception
 102             in case of other problems
 103      */
 104     ::com::sun::star::uno::XInterface createInstanceInitNew(
 105             [in] sequence< byte > aClassID,
 106             [in] string sClassName,
 107             [in] ::com::sun::star::embed::XStorage xStorage,
 108              [in] string sEntryName,
 109             [in] sequence< ::com::sun::star::beans::PropertyValue > aObjectArgs )
 110         raises( ::com::sun::star::lang::IllegalArgumentException,
 111                 ::com::sun::star::io::IOException,
 112                 ::com::sun::star::uno::Exception );
 113
 114
 115     // -----------------------------------------------------------------------
 116     /** creates a new object that should be based on specified storage entry.
 117
 118         <p> The specified entry must exists and the object should be loaded
 119         from the entry. In case a persistent representation of a link is
 120         specified, the result object will be a link.
 121         </p>
 122
 123         @param xStorage
 124             a parent storage the entry should be opened in
 125
 126         @param sEntryName
 127             a name for the entry
 128
 129         @param aMediaDescriptor
 130             an object of type
 131             <type scope="com::sun::star::document">MediaDescriptor</type> that
 132             specifies document related properties; please remember that target
 133             related parameters, for example URL, will be ignored since the
 134             object should be loaded from storage entry
 135
 136         @param aObjectArgs
 137             an object of type <type>EmbeddedObjectDescriptor</type>
 138             contains object related properties
 139
 140         @thrown ::com::sun::star::lang::IllegalArgumentException
 141             one of arguments is illegal
 142
 143         @thrown ::com::sun::star::container::NoSuchElementException
 144             the specified entry does not exist
 145
 146         @throws com::sun::star::io::IOException
 147             in case of io problems during opening
 148
 149         @throws com::sun::star::uno::Exception
 150             in case of other problems
 151      */
 152     ::com::sun::star::uno::XInterface createInstanceInitFromEntry(
 153             [in] ::com::sun::star::embed::XStorage xStorage,
 154             [in] string sEntryName,
 155             [in] sequence< ::com::sun::star::beans::PropertyValue > aMediaDescriptor,
 156             [in] sequence< ::com::sun::star::beans::PropertyValue > aObjectArgs )
 157         raises( ::com::sun::star::lang::IllegalArgumentException,
 158                 ::com::sun::star::container::NoSuchElementException,
 159                 ::com::sun::star::io::IOException,
 160                 ::com::sun::star::uno::Exception );
 161
 162     // -----------------------------------------------------------------------
 163     /** creates a new object and initializes it based on
 164         <type scope="com::sun::star::document">MediaDescriptor</type>.
 165
 166         <p> In case specified entry exists it's contents are ignored and will
 167         be overwritten on storing.
 168         </p>
 169
 170         @param xStorage
 171             a parent storage the entry should be created/opened in
 172
 173         @param sEntryName
 174             a name for the entry
 175
 176         @param aMediaDescriptor
 177             an object of type
 178             <type scope="com::sun::star::document">MediaDescriptor</type> that
 179             specifies source
 180
 181         @param aObjectArgs
 182             an object of type <type>EmbeddedObjectDescriptor</type>
 183             contains object related properties
 184
 185         @thrown ::com::sun::star::lang::IllegalArgumentException
 186             one of arguments is illegal
 187
 188         @throws com::sun::star::io::IOException
 189             in case of io problems during opening\creation
 190
 191         @throws com::sun::star::uno::Exception
 192             in case of other problems
 193      */
 194     ::com::sun::star::uno::XInterface createInstanceInitFromMediaDescriptor(
 195             [in] ::com::sun::star::embed::XStorage xStorage,
 196             [in] string sEntryName,
 197              [in] sequence< ::com::sun::star::beans::PropertyValue > aMediaDescriptor,
 198             [in] sequence< ::com::sun::star::beans::PropertyValue > aObjectArgs )
 199         raises( ::com::sun::star::lang::IllegalArgumentException,
 200                 ::com::sun::star::io::IOException,
 201                 ::com::sun::star::uno::Exception );
 202 };
 203
 204 //============================================================================
 205
 206 }; }; }; };
 207
 208 #endif
 209