/**
 * $id:  $
 */
package org.jvnet.lookout.google.web.preference;


/**
 * 
 * These are the preferences supported by the Web Search Engine.
 * @author Cleo Barretto
 *
 */
public class Preferences {

	//See this page for more details: 
	//http://www.google.com/apis/reference.html#2_2
	
	/**
	 * The client's Google Web API's key.
	 */
	public static String Key = "Key";
	
	/**
	 * The site to search in.
	 */
	public static String SiteToSearch = "SiteToSearch";
	
	/**
	 * The date from which documents should be searched. It is represented as the julian date in the past. 
	 * It can be obtained by the org.jvnet.lookout.core.util.Utilities.getJulianDate.
	 */
	public static String DateToSearchFrom = "DateToSearchFrom";

	/**
	 * The part of the resource that should be searched. Valid values are listed in this class.
	 */
	public static String PartOfResourceToSearch = "PartOfResourceToSearch";

	public static String UrlPart = "UrlPart";
	public static String TitlePart = "TitlePart";
	public static String BodyPart = "BodyPart";

	//Pratically, it has no useful effect, so it will not be available
	//public static String LinksPart = "LinksPart";
	
	public static String AnyPart = "AnyPart";	
	
	/**
	 * Comma separated String containing the file extensions to be included when searching for files.
	 */
	public static String SearchableFileTypes = "SearchableFileTypes";		

	/**
	 * Boolean indicating whether or not to search all types of files(doc, xls, txt, pdf...).  
	 */
	public static String SearchAllFiles = "SearchAllFiles";

}
