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
28#ifndef __com_sun_star_sheet_XExternalDocLinks_idl__
29#define __com_sun_star_sheet_XExternalDocLinks_idl__
30
31#include <com/sun/star/sheet/XExternalDocLink.idl>
32#include <com/sun/star/container/XNameAccess.idl>
33#include <com/sun/star/container/XIndexAccess.idl>
34#include <com/sun/star/container/XEnumerationAccess.idl>
35
36module com {  module sun {  module star {  module sheet {
37
38/** Primary interface for the <type scope="com::sun::star::sheet">ExternalDocLinks</type> service.
39
40    @see com::sun::star::sheet::ExternalDocLinks
41
42    @since OOo 3.1
43 */
44interface XExternalDocLinks
45{
46    interface com::sun::star::container::XNameAccess;
47    interface com::sun::star::container::XIndexAccess;
48    interface com::sun::star::container::XEnumerationAccess;
49
50    /** This method adds a new external document link by its URL, and returns
51        its instance.  If a document instance already exists for the specified URL,
52        then that instance gets returned instead of creating a new one.
53
54        @param aDocName document URL (e.g. file:///path/to/document.ods)
55
56        @return com::sun::star::sheet::XExternalDocLink external document link instance
57     */
58    com::sun::star::sheet::XExternalDocLink addDocLink( [in] string aDocName );
59};
60
61}; }; }; };
62
63#endif
64