KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > help > search > ISearchEngine2


1 /***************************************************************************************************
2  * Copyright (c) 2005 IBM Corporation and others. All rights reserved. This program and the
3  * accompanying materials are made available under the terms of the Eclipse Public License v1.0
4  * which accompanies this distribution, and is available at
5  * http://www.eclipse.org/legal/epl-v10.html
6  *
7  * Contributors: IBM Corporation - initial API and implementation
8  **************************************************************************************************/
9 package org.eclipse.help.search;
10
11 /**
12  * An extension of the search engine interface that provides for opening of the results. Engines
13  * that return hits that cannot be opened into the web browser should implement this interface and
14  * also indicate that the search results should be opened by the engine using
15  * {@link ISearchEngineResult2#canOpen()}.
16  *
17  * @since 3.2
18  *
19  */
20
21 public interface ISearchEngine2 extends ISearchEngine {
22
23     /**
24      * Opens the search result using the engine-specific identifier. When performing the search
25      * operation, search engine is responsible for tagging the results with unique identifiers that
26      * fully reference the results and are not transient. These identifiers can be later used to
27      * open the results by delegating the operation to the engine, or to bookmark the results for
28      * future opening.
29      *
30      * @param id
31      * The engine-specific identifier provided by the search result
32      * @return <code>true</code> if the operation was successful, or <code>false</code> if the
33      * help system should try to open the hit using the provided href.
34      */
35     boolean open(String JavaDoc id);
36 }
37
Popular Tags