1 /*************************************************************************
2  *
3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4  *
5  * Copyright 2000, 2010 Oracle and/or its affiliates.
6  *
7  * OpenOffice.org - a multi-platform office productivity suite
8  *
9  * This file is part of OpenOffice.org.
10  *
11  * OpenOffice.org is free software: you can redistribute it and/or modify
12  * it under the terms of the GNU Lesser General Public License version 3
13  * only, as published by the Free Software Foundation.
14  *
15  * OpenOffice.org is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU Lesser General Public License version 3 for more details
19  * (a copy is included in the LICENSE file that accompanied this code).
20  *
21  * You should have received a copy of the GNU Lesser General Public License
22  * version 3 along with OpenOffice.org.  If not, see
23  * <http://www.openoffice.org/license.html>
24  * for a copy of the LGPLv3 License.
25  *
26  ************************************************************************/
27 
28 #ifndef INCLUDED_DESKTOP_SOURCE_DEPLOYMENT_INC_DP_DEPENDENCIES_HXX
29 #define INCLUDED_DESKTOP_SOURCE_DEPLOYMENT_INC_DP_DEPENDENCIES_HXX
30 
31 #include "sal/config.h"
32 #include "com/sun/star/uno/Reference.hxx"
33 #include "com/sun/star/uno/Sequence.hxx"
34 #include "dp_misc_api.hxx"
35 
36 /// @HTML
37 
38 namespace com { namespace sun { namespace star { namespace xml { namespace dom {
39     class XElement;
40 } } } } }
41 namespace dp_misc { class DescriptionInfoset; }
42 namespace rtl { class OUString; }
43 
44 namespace dp_misc {
45 
46 /**
47    Dependency handling.
48 */
49 namespace Dependencies {
50     /**
51        Check for unsatisfied dependencies.
52 
53        @param infoset
54        the infoset containing the dependencies to check
55 
56        @return
57        a list of the unsatisfied dependencies from <code>infoset</code> (in no
58        specific order)
59     */
60     DESKTOP_DEPLOYMENTMISC_DLLPUBLIC
61     ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Reference<
62         ::com::sun::star::xml::dom::XElement > >
63     check(::dp_misc::DescriptionInfoset const & infoset);
64 
65     /**
66        Obtain the (human-readable) error message of a failed dependency.
67 
68        @param dependency
69        a dependency represented as a non-null XML element
70 
71        @return
72        the name of the dependency; will never be empty, as a localized
73        &ldquo;unknown&rdquo; is substituted for an empty/missing name
74      */
75     DESKTOP_DEPLOYMENTMISC_DLLPUBLIC ::rtl::OUString getErrorText(
76         ::com::sun::star::uno::Reference<
77             ::com::sun::star::xml::dom::XElement > const & dependency);
78 }
79 
80 }
81 
82 #endif
83