1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#include <com/sun/star/uno/XInterface.idl>
25#include <com/sun/star/uno/Exception.idl>
26
27module com { module sun { module star { module container {
28interface XEnumeration;
29}; }; }; };
30
31module com { module sun { module star { module task {
32interface XInteractionHandler;
33}; }; }; };
34
35module com { module sun { module star { module xml { module dom {
36interface XElement;
37}; }; }; }; };
38
39module com { module sun { module star { module deployment {
40
41/** Objects implementing this interface provide access to the xml root of
42    one or more update information files for a given set of URLs.
43
44    @since OpenOffice 2.2
45*/
46interface XUpdateInformationProvider
47{
48    /** get update information for a specific extension or all available
49        information from a repository.
50
51        @param repositories
52               a repository and its mirrors.
53        @param extensionId
54               the unique identifier of an extension. If it is not empty and
55               the update document is an atom feed, only items whose 'term'
56               attribute of the atom:category tag matches extensionId are returned.
57
58    */
59    sequence < com::sun::star::xml::dom::XElement > getUpdateInformation(
60        [in] sequence< string > repositories,
61        [in] string extensionId
62    ) raises ( com::sun::star::uno::Exception );
63
64    /** interrupts a getUpdateInformation call and let's it return immediately.
65    */
66    void cancel();
67
68    /** Sets an interaction handler to be used for further operations.
69
70    <p>
71    A default interaction handler is available as service
72        <type scope="com::sun::star::task">InteractionHandler</type>.
73        The documentation of this service also contains further
74        information about the interaction handler concept.
75    </p>
76
77    @see com::sun::star::task::InteractionHandler
78
79    @param handler
80           The interaction handler to be set
81    */
82    void setInteractionHandler( [in] com::sun::star::task::XInteractionHandler handler );
83
84	/** get update information for a specific extension or all available
85        information from a repository.
86
87        @param repositories
88               a repository and its mirrors.
89        @param extensionId
90               the unique identifier of an extension. If it is not empty and
91               the update document is an atom feed, only items whose 'term'
92               attribute of the atom:category tag matches extensionId are returned.
93
94        @returns
95               an enumeration of <type>UpdateInformationEntry</type>.
96    */
97    com::sun::star::container::XEnumeration getUpdateInformationEnumeration(
98        [in] sequence< string > repositories,
99        [in] string extensionId
100    ) raises ( com::sun::star::uno::Exception );
101};
102
103}; }; }; };
104
105