offapi/com/sun/star/deployment/XPackageInformationProvider.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: XPackageInformationProvider.idl,v $
  10  * $Revision: 1.4 $
  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 deployment {
  36
  37 /** Objects implementing this interface provide an URL to the root of
  38     an installed package.
  39
  40     @since OOo 2.3
  41 */
  42 interface XPackageInformationProvider
  43 {
  44     /** get Package information for a specific extension.
  45
  46         @param extensionId
  47                the unique identifier of an extension. The service looks for
  48                an installed package with the given id and returns the URL to
  49                the root of the package. If the service can not find a matching
  50                package, an emty string will be returned.
  51     */
  52     string getPackageLocation( [in] string extensionId );
  53
  54     /** check if there are updates available for an extention.
  55
  56         @param extensionId
  57                the unique identifier of an extension. When the extensionId is empty,
  58                the service looks checks all installed extensions for a newer version,
  59                otherwise the service looks for updates for an installed package with
  60                the given id.
  61        If the service finds an update for an extension, a sequence containing the name
  62             and the version will be returned for each extension which has an update.
  63        If the service can not find a matching package, an empty sequence is returned.
  64     */
  65     sequence< sequence< string > > isUpdateAvailable( [in] string extensionId );
  66
  67     /** returns a list of all installed extention with their version.
  68     */
  69     sequence< sequence< string > > getExtensionList();
  70 };
  71
  72 }; }; }; };
  73