offapi/com/sun/star/deployment/DependencyException.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: DependencyException.idl,v $
  10  * $Revision: 1.3 $
  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 #ifndef INCLUDED_COM_SUN_STAR_DEPLOYMENT_DEPENDENCYEXCEPTION_IDL
  32 #define INCLUDED_COM_SUN_STAR_DEPLOYMENT_DEPENDENCYEXCEPTION_IDL
  33
  34 #include "com/sun/star/uno/Exception.idl"
  35
  36 module com { module sun { module star { module xml { module dom {
  37     interface XElement;
  38 }; }; }; }; };
  39
  40 module com { module sun { module star { module deployment {
  41
  42 /**
  43    describes unsatisfied dependencies a deployment unit has on its target
  44    environment.
  45
  46    <p>This exception is intended to be used with an
  47    <type scope="com::sun::star::task">XInteractionHandler</type>.</p>
  48
  49    @since OOo 2.0.4
  50 */
  51 exception DependencyException: com::sun::star::uno::Exception {
  52     /**
  53        a sequence of dependencies represented by XML elements.
  54
  55        <p>The exact nature of those XML elements is deliberately left open, so
  56        that new kinds of dependencies can be defined in the future.
  57        OOo&nbsp;2.0.4 does not define any kinds of dependencies.  Each such XML
  58        element should have an attribute whose global name consists of the
  59        namespace name
  60        <code>http://openoffice.org/extensions/description/2006</code> and the
  61        local part <code>name</code> and whose value is a human-readable
  62        (english) description of the dependency.  If an instance of OOo does not
  63        know more about a specific kind of dependency, it should display the
  64        value of that attribute to the user.</p>
  65
  66        <p>The sequence must not be emtpy, and none of the elements may be
  67        <NULL/>.</p>
  68     */
  69     sequence< com::sun::star::xml::dom::XElement > UnsatisfiedDependencies;
  70 };
  71
  72 }; }; }; };
  73
  74 #endif