/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 * 
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/

#ifndef __com_sun_star_sheet_XExternalDocLinks_idl__
#define __com_sun_star_sheet_XExternalDocLinks_idl__

#include <com/sun/star/sheet/XExternalDocLink.idl>
#include <com/sun/star/container/XNameAccess.idl>
#include <com/sun/star/container/XIndexAccess.idl>
#include <com/sun/star/container/XEnumerationAccess.idl>

module com {  module sun {  module star {  module sheet {

/** Primary interface for the <type scope="com::sun::star::sheet">ExternalDocLinks</type> service.

    @see com::sun::star::sheet::ExternalDocLinks

    @since OOo 3.1
 */
interface XExternalDocLinks
{
    interface com::sun::star::container::XNameAccess;
    interface com::sun::star::container::XIndexAccess;
    interface com::sun::star::container::XEnumerationAccess;

    /** This method adds a new external document link by its URL, and returns
        its instance.  If a document instance already exists for the specified URL,
        then that instance gets returned instead of creating a new one.

        @param aDocName document URL (e.g. file:///path/to/document.ods)

        @return com::sun::star::sheet::XExternalDocLink external document link instance
     */
    com::sun::star::sheet::XExternalDocLink addDocLink( [in] string aDocName );
};

}; }; }; };

#endif
