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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_deployment_XPackageInformationProvider_idl__
  21 #define __com_sun_star_deployment_XPackageInformationProvider_idl__
  22
  23 #include <com/sun/star/uno/XInterface.idl>
  24 #include <com/sun/star/uno/Exception.idl>
  25
  26 module com { module sun { module star { module deployment {
  27
  28 /** Objects implementing this interface provide an URL to the root of
  29     an installed package.
  30
  31     @since OOo 2.3
  32 */
  33 interface XPackageInformationProvider
  34 {
  35     /** get Package information for a specific extension.
  36
  37         @param extensionId
  38                the unique identifier of an extension. The service looks for
  39                an installed package with the given id and returns the URL to
  40                the root of the package. If the service can not find a matching
  41                package, an empty string will be returned.
  42     */
  43     string getPackageLocation( [in] string extensionId );
  44
  45     /** check if there are updates available for an extension.
  46
  47         @param extensionId
  48                the unique identifier of an extension. When the extensionId is empty,
  49                the service looks checks all installed extensions for a newer version,
  50                otherwise the service looks for updates for an installed package with
  51                the given id.
  52        If the service finds an update for an extension, a sequence containing the name
  53             and the version will be returned for each extension which has an update.
  54        If the service can not find a matching package, an empty sequence is returned.
  55     */
  56     sequence< sequence< string > > isUpdateAvailable( [in] string extensionId );
  57
  58     /** returns a list of all installed extension with their version.
  59     */
  60     sequence< sequence< string > > getExtensionList();
  61 };
  62
  63 }; }; }; };
  64 #endif
  65
  66 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */