desktop/source/deployment/inc/dp_dependencies.hxx

   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: dp_dependencies.hxx,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_DESKTOP_SOURCE_DEPLOYMENT_INC_DP_DEPENDENCIES_HXX
  32 #define INCLUDED_DESKTOP_SOURCE_DEPLOYMENT_INC_DP_DEPENDENCIES_HXX
  33
  34 #include "sal/config.h"
  35 #include "com/sun/star/uno/Reference.hxx"
  36 #include "com/sun/star/uno/Sequence.hxx"
  37 #include "dp_misc_api.hxx"
  38
  39 /// @HTML
  40
  41 namespace com { namespace sun { namespace star { namespace xml { namespace dom {
  42     class XElement;
  43 } } } } }
  44 namespace dp_misc { class DescriptionInfoset; }
  45 namespace rtl { class OUString; }
  46
  47 namespace dp_misc {
  48
  49 /**
  50    Dependency handling.
  51 */
  52 namespace Dependencies {
  53     /**
  54        Check for unsatisfied dependencies.
  55
  56        @param infoset
  57        the infoset containing the dependencies to check
  58
  59        @return
  60        a list of the unsatisfied dependencies from <code>infoset</code> (in no
  61        specific order)
  62     */
  63     DESKTOP_DEPLOYMENTMISC_DLLPUBLIC
  64     ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Reference<
  65         ::com::sun::star::xml::dom::XElement > >
  66     check(::dp_misc::DescriptionInfoset const & infoset);
  67
  68     /**
  69        Obtain the (human-readable) name of a dependency.
  70
  71        @param dependency
  72        a dependency represented as a non-null XML element
  73
  74        @return
  75        the name of the dependency; will never be empty, as a localized
  76        &ldquo;unknown&rdquo; is substituted for an empty/missing name
  77      */
  78     DESKTOP_DEPLOYMENTMISC_DLLPUBLIC ::rtl::OUString name(
  79         ::com::sun::star::uno::Reference<
  80             ::com::sun::star::xml::dom::XElement > const & dependency);
  81
  82     /**
  83        Obtain the (human-readable) error message of a failed dependency.
  84
  85        @param dependency
  86        a dependency represented as a non-null XML element
  87
  88        @return
  89        the name of the dependency; will never be empty, as a localized
  90        &ldquo;unknown&rdquo; is substituted for an empty/missing name
  91      */
  92     DESKTOP_DEPLOYMENTMISC_DLLPUBLIC ::rtl::OUString getErrorText(
  93         ::com::sun::star::uno::Reference<
  94             ::com::sun::star::xml::dom::XElement > const & dependency);
  95 }
  96
  97 }
  98
  99 #endif