/* ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (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.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Original Code is Verbosio File Search Service.
 *
 * The Initial Developer of the Original Code is
 * Alexander J. Vincent <ajvincent@gmail.com>.
 * Portions created by the Initial Developer are Copyright (C) 2007
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */

#include "nsISupports.idl"
#include "xeIFileSearchResult.idl"
#include "xeIFileSearchFilter.idl"

[scriptable, uuid(4136e149-5bfa-4de4-a995-64dbd61d64ef)]
interface xeIFileSearchCriteria : nsISupports
{
  /**
   * Add a property to filter files and directories for.
   *
   * @param aName  Name of the property to check.
   * @param aValue Value which the property must match.
   */
  void filterPropertyString(in ACString aName,
                            in ACString aValue);

  /**
   * Add a filter for a property.
   *
   * @param aName  Name of the property to check.
   * @param aFilter The filter object for that property.
   */
  void filterPropertyFunction(in ACString aName,
                              in xeIFileSearchFilter aFilter);

  /**
   * Add a filter for a required string of content.
   *
   * @param aRequiredContent Value which the file must contain.
   */
  void filterContentsString(in ACString aRequiredContent);

  /**
   * Add a filter for the contents of the file.
   *
   * @param aName  Name of the property to check.
   * @param aFilter The filter object for that property.
   */
  void filterContentsFunction(in xeIFileSearchFilter aFilter);
};
