|
Eclipse Platform Release 3.6 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IEngineDescriptor
Descriptor of a concrete instance of a search engine. It describes the search engine instance that is either loaded from the plug-in extension point contribution, or created by the user in the scope settings dialog. Engines created by the user are marked as such. Only user-defined engines will permit their label or description changed.
This interface is not intended to be extended or implemented by clients.
Method Summary | |
---|---|
String |
getDescription()
Returns the description of this engine instance. |
String |
getEngineTypeId()
Returns the unique identifier of the engine type of which this is an instance. |
String |
getId()
Returns the unique identifier of this engine instance. |
String |
getLabel()
Returns the label of this engine for rendering in the UI. |
Dictionary |
getParameters()
Returns the parameters used to configure this engine according to the valid parameters for the associated engine type. |
boolean |
isUserDefined()
Tests whether this engine is provided as an extension point contribution or is created by the user in the scope settings dialog. |
void |
setDescription(String desc)
Changes the description of this engine. |
void |
setLabel(String label)
Changes the label of this engine. |
Method Detail |
---|
String getId()
String getEngineTypeId()
String getLabel()
void setLabel(String label)
label
- the new engine labelString getDescription()
void setDescription(String desc)
desc
- the new engine descriptionDictionary getParameters()
boolean isUserDefined()
true
if the engine is user defined, or
false
otherwise.
|
Eclipse Platform Release 3.6 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2010. All rights reserved.