1 /**************************************************************
2  *
3  * Licensed to the Apache Software Foundation (ASF) under one
4  * or more contributor license agreements.  See the NOTICE file
5  * distributed with this work for additional information
6  * regarding copyright ownership.  The ASF licenses this file
7  * to you under the Apache License, Version 2.0 (the
8  * "License"); you may not use this file except in compliance
9  * with the License.  You may obtain a copy of the License at
10  *
11  *   http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing,
14  * software distributed under the License is distributed on an
15  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16  * KIND, either express or implied.  See the License for the
17  * specific language governing permissions and limitations
18  * under the License.
19  *
20  *************************************************************/
21 
22 
23 
24 #ifndef INCLUDED_DESKTOP_SOURCE_DEPLOYMENT_INC_DP_DEPENDENCIES_HXX
25 #define INCLUDED_DESKTOP_SOURCE_DEPLOYMENT_INC_DP_DEPENDENCIES_HXX
26 
27 #include "sal/config.h"
28 #include "com/sun/star/uno/Reference.hxx"
29 #include "com/sun/star/uno/Sequence.hxx"
30 #include "dp_misc_api.hxx"
31 
32 /// @HTML
33 
34 namespace com { namespace sun { namespace star { namespace xml { namespace dom {
35     class XElement;
36 } } } } }
37 namespace dp_misc { class DescriptionInfoset; }
38 namespace rtl { class OUString; }
39 
40 namespace dp_misc {
41 
42 /**
43    Dependency handling.
44 */
45 namespace Dependencies {
46     /**
47        Check for unsatisfied dependencies.
48 
49        @param infoset
50        the infoset containing the dependencies to check
51 
52        @return
53        a list of the unsatisfied dependencies from <code>infoset</code> (in no
54        specific order)
55     */
56     DESKTOP_DEPLOYMENTMISC_DLLPUBLIC
57     ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Reference<
58         ::com::sun::star::xml::dom::XElement > >
59     check(::dp_misc::DescriptionInfoset const & infoset);
60 
61     /**
62        Obtain the (human-readable) error message of a failed dependency.
63 
64        @param dependency
65        a dependency represented as a non-null XML element
66 
67        @return
68        the name of the dependency; will never be empty, as a localized
69        &ldquo;unknown&rdquo; is substituted for an empty/missing name
70      */
71     DESKTOP_DEPLOYMENTMISC_DLLPUBLIC ::rtl::OUString getErrorText(
72         ::com::sun::star::uno::Reference<
73             ::com::sun::star::xml::dom::XElement > const & dependency);
74 }
75 
76 }
77 
78 #endif
79