Package com.orchestranetworks.search.strategy

# Interface SynonymDeclaration

public interface SynonymDeclaration
This interface represents a list a synonyms to declare in a module.

Since:
  6.0.0
See Also:
  - `ModuleSearchRegistrationContext.registerSynonyms(SynonymDeclaration, List)`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `SynonymsKey`
  `getSynonymsKey()`
  Returns the identifier of the synonym list.
  `UserMessage`
  `getUserDescription()`
  Returns the description of this synonym list.
  `UserMessage`
  `getUserLabel()`
  Returns the label of the synonym list.
  `static SynonymDeclaration`
  `of(SynonymsKey aKey, UserMessage aUserLabel, UserMessage aUserDescription)`
  Returns an instance of synonym declaration.

- ## Method Details

  - ### of

    static SynonymDeclaration of(SynonymsKey aKey, UserMessage aUserLabel, UserMessage aUserDescription)
    Returns an instance of synonym declaration.
    Parameters:
      `aKey` - the key of the synonyms associated with this declaration.
      `aUserLabel` - the label to display in the Data Model Assistant.
      `aUserDescription` - the description to display in the Data Model Assistant.

  - ### getUserLabel

    UserMessage getUserLabel()
    Returns the label of the synonym 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 of this synonym list.

    This localized description is used mainly in the Data Model Assistant to display a user-friendly description for this list.

  - ### getSynonymsKey

    SynonymsKey getSynonymsKey()
    Returns the identifier of the synonym list.