offapi/com/sun/star/deployment/XUpdateInformationProvider.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XUpdateInformationProvider.idl,v $
  10  * $Revision: 1.5 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31
  32 #include <com/sun/star/uno/XInterface.idl>
  33 #include <com/sun/star/uno/Exception.idl>
  34
  35 module com { module sun { module star { module container {
  36 interface XEnumeration;
  37 }; }; }; };
  38
  39 module com { module sun { module star { module task {
  40 interface XInteractionHandler;
  41 }; }; }; };
  42
  43 module com { module sun { module star { module xml { module dom {
  44 interface XElement;
  45 }; }; }; }; };
  46
  47 module com { module sun { module star { module deployment {
  48
  49 /** Objects implementing this interface provide access to the xml root of
  50     one or more update information files for a given set of URLs.
  51
  52     @since OOo 2.2
  53 */
  54 interface XUpdateInformationProvider
  55 {
  56     /** get update information for a specific extension or all available
  57         information from a repository.
  58
  59         @param repositories
  60                a repository and its mirrors.
  61         @param extensionId
  62                the unique identifier of an extension. If it is not empty and
  63                the update document is an atom feed, only items whose 'term'
  64                attribute of the atom:category tag matches extensionId are returned.
  65
  66     */
  67     sequence < com::sun::star::xml::dom::XElement > getUpdateInformation(
  68         [in] sequence< string > repositories,
  69         [in] string extensionId
  70     ) raises ( com::sun::star::uno::Exception );
  71
  72     /** interrupts a getUpdateInformation call and let's it return immediatly.
  73     */
  74     void cancel();
  75
  76     /** Sets an interaction handler to be used for further operations.
  77
  78     <p>
  79     A default interaction handler is available as service
  80         <type scope="com::sun::star::task">InteractionHandler</type>.
  81         The documentation of this service also contains further
  82         information about the interaction handler concept.
  83     </p>
  84
  85     @see com::sun::star::task::InteractionHandler
  86
  87     @param handler
  88            The interaction handler to be set
  89     */
  90     void setInteractionHandler( [in] com::sun::star::task::XInteractionHandler handler );
  91
  92     /** get update information for a specific extension or all available
  93         information from a repository.
  94
  95         @param repositories
  96                a repository and its mirrors.
  97         @param extensionId
  98                the unique identifier of an extension. If it is not empty and
  99                the update document is an atom feed, only items whose 'term'
 100                attribute of the atom:category tag matches extensionId are returned.
 101
 102         @returns
 103                an enumeration of <type>UpdateInformationEntry</type>.
 104     */
 105     com::sun::star::container::XEnumeration getUpdateInformationEnumeration(
 106         [in] sequence< string > repositories,
 107         [in] string extensionId
 108     ) raises ( com::sun::star::uno::Exception );
 109 };
 110
 111 }; }; }; };
 112