1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 *   Licensed to the Apache Software Foundation (ASF) under one or more
12 *   contributor license agreements. See the NOTICE file distributed
13 *   with this work for additional information regarding copyright
14 *   ownership. The ASF licenses this file to you under the Apache
15 *   License, Version 2.0 (the "License"); you may not use this file
16 *   except in compliance with the License. You may obtain a copy of
17 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19#ifndef __com_sun_star_embed_XLinkCreator_idl__
20#define __com_sun_star_embed_XLinkCreator_idl__
21
22#include <com/sun/star/uno/XInterface.idl>
23#include <com/sun/star/embed/XStorage.idl>
24#include <com/sun/star/io/IOException.idl>
25#include <com/sun/star/embed/WrongStateException.idl>
26#include <com/sun/star/lang/IllegalArgumentException.idl>
27#include <com/sun/star/beans/PropertyValue.idl>
28
29
30 module com {  module sun {  module star {  module embed {
31
32/** allows to create and initialize a new link.
33    <p>
34    Methods of this interface does not require specification of the object type,
35    it will be detected.
36    </p>
37 */
38published interface XLinkCreator: com::sun::star::uno::XInterface
39{
40    /** creates a new object based on
41        com::sun::star::document::MediaDescriptor
42        and initializes it as a link.
43
44        <p>
45        In case the entry exists already all its contents will be ignored and
46        rewritten on storing of the object.
47        </p>
48
49        @param xStorage
50            a parent storage the entry should be created or opened in
51
52        @param sEntryName
53            a name for the entry
54
55        @param aArgs
56            com::sun::star::document::MediaDescriptor
57            the link will be based on
58
59        @param aObjectArgs
60            optional parameters for the object persistence initialization,
61            see also
62            com::sun::star::embed::EmbeddedObjectDescriptor
63
64        @throws ::com::sun::star::lang::IllegalArgumentException
65            the argument is illegal
66
67        @throws com::sun::star::io::IOException
68            in case of io problems during opening or creation
69
70        @throws com::sun::star::uno::Exception
71            in case of other problems
72     */
73    ::com::sun::star::uno::XInterface createInstanceLink(
74            [in] ::com::sun::star::embed::XStorage xStorage,
75             [in] string sEntryName,
76             [in] sequence< ::com::sun::star::beans::PropertyValue > aArgs,
77            [in] sequence< ::com::sun::star::beans::PropertyValue > aObjectArgs )
78        raises( ::com::sun::star::lang::IllegalArgumentException,
79                ::com::sun::star::io::IOException,
80                ::com::sun::star::uno::Exception );
81};
82
83
84}; }; }; };
85
86#endif
87
88/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
89