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

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