offapi/com/sun/star/ucb/XPropertyMatcher.idl

   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 #ifndef __com_sun_star_ucb_XPropertyMatcher_idl__
  28 #define __com_sun_star_ucb_XPropertyMatcher_idl__
  29
  30 #ifndef __com_sun_star_uno_XInterface_idl__
  31 #include <com/sun/star/uno/XInterface.idl>
  32 #endif
  33
  34 #ifndef __com_sun_star_ucb_XCommandProcessor_idl__
  35 #include <com/sun/star/ucb/XCommandProcessor.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_ucb_XCommandEnvironment_idl__
  39 #include <com/sun/star/ucb/XCommandEnvironment.idl>
  40 #endif
  41
  42 //=============================================================================
  43
  44 module com { module sun { module star { module ucb {
  45
  46 //=============================================================================
  47 /** Checks whether a set of properties matches a set of search criteria.
  48
  49     @see  XPropertyMatcherFactory.
  50 */
  51 published interface XPropertyMatcher : com::sun::star::uno::XInterface
  52 {
  53     //-------------------------------------------------------------------------
  54     /** Checks whether a set of properties matches the given search criteria.
  55
  56         @param Properties
  57         A Command Processor through which the set of properties is accessible.
  58
  59         @param Environment
  60         The environment to use when accessing the property  set via the given
  61          Command Processor.  It may be null.
  62
  63         @returns
  64         <TRUE/> if the properties match, <FALSE/> otherwise.
  65     */
  66     boolean matches([in] com::sun::star::ucb::XCommandProcessor Properties,
  67                     [in] com::sun::star::ucb::XCommandEnvironment Environment);
  68 };
  69
  70 //=============================================================================
  71
  72 }; }; }; };
  73
  74 #endif