xref: /AOO41X/main/offapi/com/sun/star/embed/XLinkFactory.idl (revision d1766043198e81d0bcfc626e12893e7b4d7e31ca)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_embed_XLinkFactory_idl__
24#define __com_sun_star_embed_XLinkFactory_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29
30#ifndef __com_sun_star_embed_XStorage_idl__
31#include <com/sun/star/embed/XStorage.idl>
32#endif
33
34#ifndef __com_sun_star_io_IOException_idl__
35#include <com/sun/star/io/IOException.idl>
36#endif
37
38#ifndef __com_sun_star_embed_WrongStateException_idl__
39#include <com/sun/star/embed/WrongStateException.idl>
40#endif
41
42#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
43#include <com/sun/star/lang/IllegalArgumentException.idl>
44#endif
45
46#ifndef __com_sun_star_beans_PropertyValue_idl__
47#include <com/sun/star/beans/PropertyValue.idl>
48#endif
49
50//============================================================================
51
52 module com {  module sun {  module star {  module embed {
53
54//============================================================================
55/** allows to create and initialize a new link of specified type.
56 */
57published interface XLinkFactory: com::sun::star::uno::XInterface
58{
59    //------------------------------------------------------------------------
60    /** creates a new link and transport parameters for persistent
61        initialization.
62
63        <p>
64        This method can be used to have a full control over persistence
65        initialization of a link.
66        </p>
67
68        @param aClassID
69            the class id of the new object
70
71        @param aClassName
72            the class name of the new object
73
74        @param xStorage
75            a parent storage the entry should be created in
76
77        @param sEntryName
78            a name for the entry
79
80        @param aArgs
81            <type scope="com::sun::star::document">MediaDescriptor</type>
82            that contains source for the link
83
84        @param aObjectArgs
85            optional parameters for the object persistence initialization
86            see also
87            <type scope="com::sun::star::embed">EmbeddedObjectDescriptor</type>
88
89        @throws ::com::sun::star::lang::IllegalArgumentException
90            one of arguments is illegal
91
92        @throws com::sun::star::io::IOException
93            in case of io problems during opening\creation
94
95        @throws com::sun::star::uno::Exception
96            in case of other problems
97     */
98    ::com::sun::star::uno::XInterface createInstanceLinkUserInit(
99            [in] sequence< byte > aClassID,
100            [in] string sClassName,
101            [in] ::com::sun::star::embed::XStorage xStorage,
102            [in] string sEntryName,
103            [in] sequence< ::com::sun::star::beans::PropertyValue > aArgs,
104            [in] sequence< ::com::sun::star::beans::PropertyValue > aObjectArgs )
105        raises( ::com::sun::star::lang::IllegalArgumentException,
106                ::com::sun::star::io::IOException,
107                ::com::sun::star::uno::Exception );
108};
109
110//============================================================================
111
112}; }; }; };
113
114#endif
115
116