xref: /aoo42x/main/offapi/com/sun/star/ucb/XPropertyMatcher.idl (revision cdf0e10c)

/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org 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 version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#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