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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20
  21 module com { module sun { module star { module ucb {
  22
  23 /** Checks whether a set of properties matches a set of search criteria.
  24
  25     @see  XPropertyMatcherFactory.
  26 */
  27 published interface XPropertyMatcher : com::sun::star::uno::XInterface
  28 {
  29     /** Checks whether a set of properties matches the given search criteria.
  30
  31         @param Properties
  32         A Command Processor through which the set of properties is accessible.
  33
  34         @param Environment
  35         The environment to use when accessing the property  set via the given
  36          Command Processor.  It may be null.
  37
  38         @returns
  39         `TRUE` if the properties match, `FALSE` otherwise.
  40     */
  41     boolean matches([in] com::sun::star::ucb::XCommandProcessor Properties,
  42                     [in] com::sun::star::ucb::XCommandEnvironment Environment);
  43 };
  44
  45
  46 }; }; }; };
  47
  48 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */