/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: XPropertyMatcher.idl,v $
 *
 *  $Revision: 1.7 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-08 08:10:52 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 by Sun Microsystems, Inc.
 *    901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License version 2.1, as published by the Free Software Foundation.
 *
 *    This library is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *    Lesser General Public License for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with this library; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *    MA  02111-1307  USA
 *
 ************************************************************************/
#ifndef __com_sun_star_ucb_XPropertyMatcher_idl__
#define __com_sun_star_ucb_XPropertyMatcher_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_ucb_XCommandProcessor_idl__
#include <com/sun/star/ucb/XCommandProcessor.idl>
#endif

#ifndef __com_sun_star_ucb_XCommandEnvironment_idl__
#include <com/sun/star/ucb/XCommandEnvironment.idl>
#endif

//=============================================================================

module com { module sun { module star { module ucb {

//=============================================================================
/** Checks whether a set of properties matches a set of search criteria.

    @see  XPropertyMatcherFactory.
*/
published interface XPropertyMatcher : com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------
    /** Checks whether a set of properties matches the given search criteria.

        @param Properties
        A Command Processor through which the set of properties is accessible.

        @param Environment
        The environment to use when accessing the property  set via the given
         Command Processor.  It may be null.

        @returns
        <TRUE/> if the properties match, <FALSE/> otherwise.
    */
    boolean matches([in] com::sun::star::ucb::XCommandProcessor Properties,
                    [in] com::sun::star::ucb::XCommandEnvironment Environment);
};

//=============================================================================

}; }; }; };

#endif
