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