StopWordsDeclaration (TIBCO EBX® Version 6.1.3 Java API)

```
public interface StopWordsDeclaration
```
This interface represents a list of stop words to be declared in a module.

Since:

6.0.0

See Also:

ModuleSearchRegistrationContext.registerStopWords(StopWordsDeclaration, List)

Method Summary

All Methods Static Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`StopWordsKey`	`getStopWordsKey()`	Returns the identifier of the list of stop words.
`UserMessage`	`getUserDescription()`	Returns the description for this list of stop words.
`UserMessage`	`getUserLabel()`	Returns the label of the stop words list.
`static StopWordsDeclaration`	`of(StopWordsKey aKey, UserMessage aUserLabel, UserMessage aUserDescription)`	Returns an instance of a declaration for a list of stop words.

- Method Detail
  - of
```
static StopWordsDeclaration of(StopWordsKey aKey,
                               UserMessage aUserLabel,
                               UserMessage aUserDescription)
```
    Returns an instance of a declaration for a list of stop words.
    
    Parameters:
    
    aKey - the key for the declaration to be created.
    
    aUserLabel - the label to be displayed in the Data Model Assistant.
    
    aUserDescription - the description to be displayed in the Data Model Assistant.
  - getUserLabel
```
UserMessage getUserLabel()
```
    Returns the label of the stop words list.
    This localized label is used mainly in the Data Model Assistant to display a user-friendly label for this list.
  - getUserDescription
```
UserMessage getUserDescription()
```
    Returns the description for this list of stop words.
    This localized description is used mainly in the Data Model Assistant to display a user-friendly description for this list.
  - getStopWordsKey
```
StopWordsKey getStopWordsKey()
```
    Returns the identifier of the list of stop words.