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#ifndef __com_sun_star_task_XUrlContainer_idl__
28#define __com_sun_star_task_XUrlContainer_idl__
29
30#ifndef __com_sun_star_uno_XInterface_idl__
31#include <com/sun/star/uno/XInterface.idl>
32#endif
33
34#ifndef __com_sun_star_task_XInteractionHandler_idl__
35#include <com/sun/star/task/XInteractionHandler.idl>
36#endif
37
38
39//=============================================================================
40
41module com { module sun { module star { module task {
42
43//=============================================================================
44/** Allows to store and retrieve URLs. URLs can be stored persistently or
45    until end of OOo session.
46
47    @since OOo 3.2
48*/
49published interface XUrlContainer : com::sun::star::uno::XInterface
50{
51    //-------------------------------------------------------------------------
52    /** Add a URL to the container.
53
54        @param Url        URL to add to the container
55        @param MakePersistent indicates whether the URL shall be stored
56                          persistently or just in memory (until end of
57                          OOo session)
58    */
59    void addUrl( [in] string Url, [in] boolean MakePersistent );
60
61    //-------------------------------------------------------------------------
62    /** Lookup a URL in the container.
63
64        @param Url     URL to lookup.
65        @returns       Best matched URL or empty string.
66    */
67    string findUrl( [in] string Url );
68
69    //-------------------------------------------------------------------------
70    /** Remove a URL from the container.
71
72        @param Url      URL to remove.
73    */
74    void removeUrl( [in] string Url );
75
76    //-------------------------------------------------------------------------
77    /** Get all URLs.
78
79        @param OnlyPersistent Only URLs taht are stored persistently shall
80                        be returned.
81        @returns        List of URLs.
82    */
83    sequence<string> getUrls( [in] boolean OnlyPersistent );
84
85};
86
87//=============================================================================
88
89}; }; }; };
90
91#endif
92