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
25#include <com/sun/star/uno/XInterface.idl>
26#include <com/sun/star/uno/Exception.idl>
27
28module com { module sun { module star { module container {
29interface XEnumeration;
30}; }; }; };
31
32module com { module sun { module star { module task {
33interface XInteractionHandler;
34}; }; }; };
35
36module com { module sun { module star { module xml { module dom {
37interface XElement;
38}; }; }; }; };
39
40module com { module sun { module star { module deployment {
41
42/** Objects implementing this interface provide access to the xml root of
43    one or more update information files for a given set of URLs.
44
45    @since OpenOffice 2.2
46*/
47interface XUpdateInformationProvider
48{
49    /** get update information for a specific extension or all available
50        information from a repository.
51
52        @param repositories
53               a repository and its mirrors.
54        @param extensionId
55               the unique identifier of an extension. If it is not empty and
56               the update document is an atom feed, only items whose 'term'
57               attribute of the atom:category tag matches extensionId are returned.
58
59    */
60    sequence < com::sun::star::xml::dom::XElement > getUpdateInformation(
61        [in] sequence< string > repositories,
62        [in] string extensionId
63    ) raises ( com::sun::star::uno::Exception );
64
65    /** interrupts a getUpdateInformation call and let's it return immediatly.
66    */
67    void cancel();
68
69    /** Sets an interaction handler to be used for further operations.
70
71    <p>
72    A default interaction handler is available as service
73        <type scope="com::sun::star::task">InteractionHandler</type>.
74        The documentation of this service also contains further
75        information about the interaction handler concept.
76    </p>
77
78    @see com::sun::star::task::InteractionHandler
79
80    @param handler
81           The interaction handler to be set
82    */
83    void setInteractionHandler( [in] com::sun::star::task::XInteractionHandler handler );
84
85	/** get update information for a specific extension or all available
86        information from a repository.
87
88        @param repositories
89               a repository and its mirrors.
90        @param extensionId
91               the unique identifier of an extension. If it is not empty and
92               the update document is an atom feed, only items whose 'term'
93               attribute of the atom:category tag matches extensionId are returned.
94
95        @returns
96               an enumeration of <type>UpdateInformationEntry</type>.
97    */
98    com::sun::star::container::XEnumeration getUpdateInformationEnumeration(
99        [in] sequence< string > repositories,
100        [in] string extensionId
101    ) raises ( com::sun::star::uno::Exception );
102};
103
104}; }; }; };
105
106