offapi/com/sun/star/embed/XEmbedObjectCreator.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_embed_XEmbedObjectCreator_idl__
  28 #define __com_sun_star_embed_XEmbedObjectCreator_idl__
  29
  30 #ifndef __com_sun_star_uno_XInterface_idl__
  31 #include <com/sun/star/uno/XInterface.idl>
  32 #endif
  33
  34 #ifndef __com_sun_star_embed_XStorage_idl__
  35 #include <com/sun/star/embed/XStorage.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_io_IOException_idl__
  39 #include <com/sun/star/io/IOException.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_embed_WrongStateException_idl__
  43 #include <com/sun/star/embed/WrongStateException.idl>
  44 #endif
  45
  46 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  47 #include <com/sun/star/lang/IllegalArgumentException.idl>
  48 #endif
  49
  50 #ifndef __com_sun_star_beans_PropertyValue_idl__
  51 #include <com/sun/star/beans/PropertyValue.idl>
  52 #endif
  53
  54 //============================================================================
  55
  56  module com {  module sun {  module star {  module embed {
  57
  58 //============================================================================
  59 /** allows to create and initialize a new embedded object.
  60
  61     <p>
  62     This interface contains methods that can help to create and initialize
  63     an embedded object.
  64     </p>
  65  */
  66 published interface XEmbedObjectCreator: com::sun::star::uno::XInterface
  67 {
  68     // -----------------------------------------------------------------------
  69     /** creates a new object and initializes it as a new one.
  70
  71         <p> In case specified entry exists it's contents are ignored and
  72         will be overwritten on storing.
  73         </p>
  74
  75         @param aClassID
  76             the class id of the new object
  77
  78         @param sClassName
  79             the class name of the new object
  80
  81         @param xStorage
  82             a parent storage the entry should be created/opened in
  83
  84         @param sEntryName
  85             a name for the entry
  86
  87         @param aObjectArgs
  88             optional parameters for the object persistence initialization
  89             see also
  90             <type>EmbeddedObjectDescriptor</type>
  91
  92         @throws ::com::sun::star::lang::IllegalArgumentException
  93             one of arguments is illegal
  94
  95         @throws com::sun::star::io::IOException
  96             in case of io problems during opening\creation
  97
  98         @throws com::sun::star::uno::Exception
  99             in case of other problems
 100      */
 101     ::com::sun::star::uno::XInterface createInstanceInitNew(
 102             [in] sequence< byte > aClassID,
 103             [in] string sClassName,
 104             [in] ::com::sun::star::embed::XStorage xStorage,
 105              [in] string sEntryName,
 106             [in] sequence< ::com::sun::star::beans::PropertyValue > aObjectArgs )
 107         raises( ::com::sun::star::lang::IllegalArgumentException,
 108                 ::com::sun::star::io::IOException,
 109                 ::com::sun::star::uno::Exception );
 110
 111
 112     // -----------------------------------------------------------------------
 113     /** creates a new object that should be based on specified storage entry.
 114
 115         <p> The specified entry must exists and the object should be loaded
 116         from the entry. In case a persistent representation of a link is
 117         specified, the result object will be a link.
 118         </p>
 119
 120         @param xStorage
 121             a parent storage the entry should be opened in
 122
 123         @param sEntryName
 124             a name for the entry
 125
 126         @param aMediaDescriptor
 127             an object of type
 128             <type scope="com::sun::star::document">MediaDescriptor</type> that
 129             specifies document related properties; please remember that target
 130             related parameters, for example URL, will be ignored since the
 131             object should be loaded from storage entry
 132
 133         @param aObjectArgs
 134             an object of type <type>EmbeddedObjectDescriptor</type>
 135             contains object related properties
 136
 137         @thrown ::com::sun::star::lang::IllegalArgumentException
 138             one of arguments is illegal
 139
 140         @thrown ::com::sun::star::container::NoSuchElementException
 141             the specified entry does not exist
 142
 143         @throws com::sun::star::io::IOException
 144             in case of io problems during opening
 145
 146         @throws com::sun::star::uno::Exception
 147             in case of other problems
 148      */
 149     ::com::sun::star::uno::XInterface createInstanceInitFromEntry(
 150             [in] ::com::sun::star::embed::XStorage xStorage,
 151             [in] string sEntryName,
 152             [in] sequence< ::com::sun::star::beans::PropertyValue > aMediaDescriptor,
 153             [in] sequence< ::com::sun::star::beans::PropertyValue > aObjectArgs )
 154         raises( ::com::sun::star::lang::IllegalArgumentException,
 155                 ::com::sun::star::container::NoSuchElementException,
 156                 ::com::sun::star::io::IOException,
 157                 ::com::sun::star::uno::Exception );
 158
 159     // -----------------------------------------------------------------------
 160     /** creates a new object and initializes it based on
 161         <type scope="com::sun::star::document">MediaDescriptor</type>.
 162
 163         <p> In case specified entry exists it's contents are ignored and will
 164         be overwritten on storing.
 165         </p>
 166
 167         @param xStorage
 168             a parent storage the entry should be created/opened in
 169
 170         @param sEntryName
 171             a name for the entry
 172
 173         @param aMediaDescriptor
 174             an object of type
 175             <type scope="com::sun::star::document">MediaDescriptor</type> that
 176             specifies source
 177
 178         @param aObjectArgs
 179             an object of type <type>EmbeddedObjectDescriptor</type>
 180             contains object related properties
 181
 182         @thrown ::com::sun::star::lang::IllegalArgumentException
 183             one of arguments is illegal
 184
 185         @throws com::sun::star::io::IOException
 186             in case of io problems during opening\creation
 187
 188         @throws com::sun::star::uno::Exception
 189             in case of other problems
 190      */
 191     ::com::sun::star::uno::XInterface createInstanceInitFromMediaDescriptor(
 192             [in] ::com::sun::star::embed::XStorage xStorage,
 193             [in] string sEntryName,
 194              [in] sequence< ::com::sun::star::beans::PropertyValue > aMediaDescriptor,
 195             [in] sequence< ::com::sun::star::beans::PropertyValue > aObjectArgs )
 196         raises( ::com::sun::star::lang::IllegalArgumentException,
 197                 ::com::sun::star::io::IOException,
 198                 ::com::sun::star::uno::Exception );
 199 };
 200
 201 //============================================================================
 202
 203 }; }; }; };
 204
 205 #endif
 206