xref: /aoo41x/main/offapi/com/sun/star/deployment/DependencyException.idl (revision cdf0e10c)

/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/

#ifndef INCLUDED_COM_SUN_STAR_DEPLOYMENT_DEPENDENCYEXCEPTION_IDL
#define INCLUDED_COM_SUN_STAR_DEPLOYMENT_DEPENDENCYEXCEPTION_IDL

#include "com/sun/star/uno/Exception.idl"

module com { module sun { module star { module xml { module dom {
    interface XElement;
}; }; }; }; };

module com { module sun { module star { module deployment {

/**
   describes unsatisfied dependencies a deployment unit has on its target
   environment.

   <p>This exception is intended to be used with an
   <type scope="com::sun::star::task">XInteractionHandler</type>.</p>

   @since OOo 2.0.4
*/
exception DependencyException: com::sun::star::uno::Exception {
    /**
       a sequence of dependencies represented by XML elements.

       <p>The exact nature of those XML elements is deliberately left open, so
       that new kinds of dependencies can be defined in the future.
       OOo&nbsp;2.0.4 does not define any kinds of dependencies.  Each such XML
       element should have an attribute whose global name consists of the
       namespace name
       <code>http://openoffice.org/extensions/description/2006</code> and the
       local part <code>name</code> and whose value is a human-readable
       (english) description of the dependency.  If an instance of OOo does not
       know more about a specific kind of dependency, it should display the
       value of that attribute to the user.</p>

       <p>The sequence must not be emtpy, and none of the elements may be
       <NULL/>.</p>
    */
    sequence< com::sun::star::xml::dom::XElement > UnsatisfiedDependencies;
};

}; }; }; };

#endif