KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > update > search > IUpdateSearchCategory


1 /*******************************************************************************
2  * Copyright (c) 2000, 2005 IBM Corporation and others.
3  * All rights reserved. This program and the accompanying materials
4  * are made available under the terms of the Eclipse Public License v1.0
5  * which accompanies this distribution, and is available at
6  * http://www.eclipse.org/legal/epl-v10.html
7  *
8  * Contributors:
9  * IBM Corporation - initial API and implementation
10  *******************************************************************************/
11 package org.eclipse.update.search;
12
13 /**
14  * This interface is used to encapsulate a particular Update
15  * search pattern. Each search category is free to scan
16  * sites using a specific algorithm. Search category must
17  * have a unique ID. The actual search is performed in
18  * search queries. A category can provide one or more
19  * queries to run during the search.
20  * <p>
21  * <b>Note:</b> This class/interface is part of an interim API that is still under development and expected to
22  * change significantly before reaching stability. It is being made available at this early stage to solicit feedback
23  * from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken
24  * (repeatedly) as the API evolves.
25  * </p>
26  * @since 3.0
27  */
28
29 public interface IUpdateSearchCategory {
30 /**
31  * Returns the unique identifier of this search category.
32  */
33     public String JavaDoc getId();
34 /**
35  * Accepts the identifier assigned to this category during
36  * the registry reading.
37  */
38     public void setId(String JavaDoc id);
39
40 /**
41  * Returns an array of update search queries that need to
42  * be run during the search.
43  * @return an arry of update search queries
44  */
45     IUpdateSearchQuery [] getQueries();
46 }
47
Popular Tags