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