org.jboss.as.console.spi

Annotation Type SearchIndex

@Retention(value=RUNTIME)
@Target(value=TYPE)
public @interface SearchIndex

Search index meta data for presenters. This annotation works as add-on for AccessControl which is the primarily source for the search index. Without specifying SearchIndex on a presenter, the presenter is indexed using the defaults specified here. Only use SearchIndex on a presenter if you want to exclude the presenter or if you want to boost the presenter by setting keywords.

Author:

Harald Pehl

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	exclude Using this flag you can exclude a presenter from the search index.
String[]	keywords Set of keywords which will be added to the index for that presenter.

Element Detail

keywords

public abstract String[] keywords

Set of keywords which will be added to the index for that presenter. Using keywords you can boost the presenter in the search result. Please use sparingly.

Returns:

an array with keywords to include in the search index

Default:

{}

exclude

public abstract boolean exclude

Using this flag you can exclude a presenter from the search index.

Returns:

whether to exclude the presenter

Default:

false