offapi/com/sun/star/embed/XLinkCreator.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: XLinkCreator.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_XLinkCreator_idl__
  31 #define __com_sun_star_embed_XLinkCreator_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 link.
  63     <p>
  64     Methods of this interface does not require specification of the object type,
  65     it will be detected.
  66     </p>
  67  */
  68 interface XLinkCreator: com::sun::star::uno::XInterface
  69 {
  70     //-------------------------------------------------------------------------
  71     /** creates a new object based on
  72         <type scope="com::sun::star::document">MediaDescriptor</type>
  73         and initializes it as a link.
  74
  75         <p>
  76         In case the entry exists already all it's contents will be ignored and
  77         rewritten on storing of the object.
  78         </p>
  79
  80         @param xStorage
  81             a parent storage the entry should be created/opened in
  82
  83         @param sEntryName
  84             a name for the entry
  85
  86         @param aArgs
  87             <type scope="com::sun::star::document">MediaDescriptor</type>
  88             the link will be based on
  89
  90         @param aObjectArgs
  91             optional parameters for the object persistence initialization,
  92             see also
  93             <type scope="com::sun::star::embed">EmbeddedObjectDescriptor</type>
  94
  95         @throws ::com::sun::star::lang::IllegalArgumentException
  96             the argument 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 createInstanceLink(
 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