offapi/com/sun/star/embed/XLinkFactory.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_XLinkFactory_idl__
  28 #define __com_sun_star_embed_XLinkFactory_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 link of specified type.
  60  */
  61 published interface XLinkFactory: com::sun::star::uno::XInterface
  62 {
  63     //------------------------------------------------------------------------
  64     /** creates a new link and transport parameters for persistent
  65         initialization.
  66
  67         <p>
  68         This method can be used to have a full control over persistence
  69         initialization of a link.
  70         </p>
  71
  72         @param aClassID
  73             the class id of the new object
  74
  75         @param aClassName
  76             the class name of the new object
  77
  78         @param xStorage
  79             a parent storage the entry should be created in
  80
  81         @param sEntryName
  82             a name for the entry
  83
  84         @param aArgs
  85             <type scope="com::sun::star::document">MediaDescriptor</type>
  86             that contains source for the link
  87
  88         @param aObjectArgs
  89             optional parameters for the object persistence initialization
  90             see also
  91             <type scope="com::sun::star::embed">EmbeddedObjectDescriptor</type>
  92
  93         @throws ::com::sun::star::lang::IllegalArgumentException
  94             one of arguments is illegal
  95
  96         @throws com::sun::star::io::IOException
  97             in case of io problems during opening\creation
  98
  99         @throws com::sun::star::uno::Exception
 100             in case of other problems
 101      */
 102     ::com::sun::star::uno::XInterface createInstanceLinkUserInit(
 103             [in] sequence< byte > aClassID,
 104             [in] string sClassName,
 105             [in] ::com::sun::star::embed::XStorage xStorage,
 106             [in] string sEntryName,
 107             [in] sequence< ::com::sun::star::beans::PropertyValue > aArgs,
 108             [in] sequence< ::com::sun::star::beans::PropertyValue > aObjectArgs )
 109         raises( ::com::sun::star::lang::IllegalArgumentException,
 110                 ::com::sun::star::io::IOException,
 111                 ::com::sun::star::uno::Exception );
 112 };
 113
 114 //============================================================================
 115
 116 }; }; }; };
 117
 118 #endif
 119