offapi/com/sun/star/embed/XEmbedObjectFactory.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: XEmbedObjectFactory.idl,v $
  10  * $Revision: 1.7 $
  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_XEmbedObjectFactory_idl__
  31 #define __com_sun_star_embed_XEmbedObjectFactory_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 of specified type.
  63     <p>
  64     This interface provides user with full control over object creation.
  65     </p>
  66  */
  67 interface XEmbedObjectFactory: com::sun::star::uno::XInterface
  68 {
  69     //------------------------------------------------------------------------
  70     /** creates a new object and transport parameters for persistent
  71         initialization.
  72
  73         <p>
  74         This method can be used to have a full control over persistence
  75         initialization of a object.
  76         </p>
  77
  78         <p>
  79         If the service implementation does not support
  80         <type>XEmbedObjectCreator</type> interface, it must accept the empty
  81         aClassID parameter in case of loading from existing entry.
  82         </p>
  83
  84         @param aClassID
  85             the class id of the new object
  86
  87         @param sClassName
  88             the class name of the new object
  89
  90         @param xStorage
  91             a parent storage the entry should be created/opened in
  92
  93         @param sEntName
  94             a name for the entry
  95
  96         @param nEntryConnectionMode
  97             a mode in which the object should be initialized from entry
  98             can take values from <type>EntryInitModes</type> constant set
  99
 100         @param aArgs
 101             optional parameters for the embedded document persistence
 102             initialization, see also
 103             <type scope="com::sun::star::document">MediaDescriptor</type>
 104
 105         @param aObjectArgs
 106             optional parameters for the object persistence initialization,
 107             see also
 108             <type scope="com::sun::star::embed">EmbeddedObjectDescriptor</type>
 109
 110         @thrown ::com::sun::star::lang::IllegalArgumentException
 111             one of arguments is illegal
 112
 113         @throws com::sun::star::io::IOException
 114             in case of io problems during opening\creation
 115
 116         @throws com::sun::star::uno::Exception
 117             in case of other problems
 118      */
 119     ::com::sun::star::uno::XInterface createInstanceUserInit(
 120             [in] sequence< byte > aClassID,
 121             [in] string sClassName,
 122             [in] ::com::sun::star::embed::XStorage xStorage,
 123             [in] string sEntName,
 124             [in] long nEntryConnectionMode,
 125             [in] sequence< ::com::sun::star::beans::PropertyValue > aArgs,
 126             [in] sequence< ::com::sun::star::beans::PropertyValue > aObjectArgs )
 127         raises( ::com::sun::star::lang::IllegalArgumentException,
 128                 ::com::sun::star::io::IOException,
 129                 ::com::sun::star::uno::Exception );
 130 };
 131
 132 //============================================================================
 133
 134 }; }; }; };
 135
 136 #endif
 137