RMP Search Service
Identifier:
com.ibm.xtools.rmp.ui.search.rmpSearchService
Since:
8.0.0
Description:
The RMP Search Service extension point allows contributing search providers to contribute to the Model Search functionality. Specifically, providers can specify supported element types and contribute appropriate UI to the Model Search page, as well as custom search results ("matches") in the search results page. Results are aggregated with all other contributing search providers. It is also possible to contribute to the reference search functionality using this extension point. Please see the public API in com.ibm.xtools.rmp.ui.search and com.ibm.xtools.rmp.ui.search.match for more details.
Configuration Markup:
<!ELEMENT extension (searchProvider)+>
<!ATTLIST extension
point CDATA #REQUIRED
id CDATA #IMPLIED
name CDATA #IMPLIED>
The RMP Search Service extension point allows contributing one or more search providers.
- point - The extension point should be "com.ibm.xtools.rmp.ui.search.rmpSearchService"
- id - Optional. ID of the extension point.
- name - Optional. Name of the extension point.
<!ELEMENT searchProvider EMPTY>
<!ATTLIST searchProvider
class CDATA #REQUIRED
supportsReferencesSearch CDATA #IMPLIED
policy CDATA #IMPLIED
id CDATA #IMPLIED
disableSearchProviders CDATA #IMPLIED>
A search provider enables searching for domain specific elements.
- class - Specify your search provider class. Your class must implement IRMPSearchProvider or IRMPReferencesSearchProvider if you are additionally supporting the "search for references" feature which is available from context menus.
- supportsReferencesSearch - Optional. Specify supportsReferencesSearch="false" for performance optimization to prevent unnecessary loading if you are not supporting references search. If unspecified, default is true.
- policy - Optional. Specify a policy for performance optimization to prevent unnecessary loading. Class must implement IRMPSearchProviderPolicy (if your search provider is a IRMPSearchProvider) or IRMPReferencesSearchProviderPolicy (if your search provider is a IRMPRferencesSearchProvider).
- id - Optional. ID of the search provider. Used primarily to allow disabling of this search provider by some other search provider. Should contain only characters allowed in a valid Java identifier, and in particular, no spaces or commas are allowed.
- disableSearchProviders - Optional. Specify a comma separated list of ids of search providers to be disabled.
API Information:
Please see the public API in com.ibm.xtools.rmp.ui.search and com.ibm.xtools.rmp.ui.search.match for more details.
Licensed Materials - Property of IBM
Copyright IBM Corp. 2010. All Rights Reserved.
US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.