xref: /aoo4110/main/offapi/com/sun/star/ucb/XPropertyMatcher.idl (revision b1cdbd2c)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the 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