offapi/com/sun/star/deployment/DependencyException.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_DEPENDENCYEXCEPTION_IDL
  21 #define _COM_SUN_STAR_DEPLOYMENT_DEPENDENCYEXCEPTION_IDL
  22
  23 #include <com/sun/star/uno/Exception.idl>
  24
  25 module com { module sun { module star { module xml { module dom {
  26     interface XElement;
  27 }; }; }; }; };
  28
  29 module com { module sun { module star { module deployment {
  30
  31 /**
  32    describes unsatisfied dependencies a deployment unit has on its target
  33    environment.
  34
  35    <p>This exception is intended to be used with an
  36    com::sun::star::task::XInteractionHandler.</p>
  37
  38    @since OOo 2.0.4
  39 */
  40 exception DependencyException: com::sun::star::uno::Exception {
  41     /**
  42        a sequence of dependencies represented by XML elements.
  43
  44        <p>The exact nature of those XML elements is deliberately left open, so
  45        that new kinds of dependencies can be defined in the future.
  46        OOo&nbsp;2.0.4 does not define any kinds of dependencies.  Each such XML
  47        element should have an attribute whose global name consists of the
  48        namespace name
  49        <code>http://openoffice.org/extensions/description/2006</code> and the
  50        local part <code>name</code> and whose value is a human-readable
  51        (English) description of the dependency.  If an instance of OOo does not
  52        know more about a specific kind of dependency, it should display the
  53        value of that attribute to the user.</p>
  54
  55        <p>The sequence must not be empty, and none of the elements may be
  56        `NULL`.</p>
  57     */
  58     sequence< com::sun::star::xml::dom::XElement > UnsatisfiedDependencies;
  59 };
  60
  61 }; }; }; };
  62
  63 #endif
  64
  65 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */