Package com.documentum.fc.client.search

# Interface IDfResultMetadataHighlightEntry

public interface IDfResultMetadataHighlightEntry
Defines an interface for the metadata highlight in search results.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `String`
  `getAttrName()`
  Gets the metadata attribute name.
  `IDfEnumeration`
  `getMatchingTerms()`
  Gets the metadata highlight terms matching the query.
  `String`
  `getSummary()`
  Gets the metadata highlight summary.

- ## Method Details

  - ### getAttrName

    String getAttrName()
    Gets the metadata attribute name.
    Returns:
      The metadata attribute name.

  - ### getMatchingTerms

    IDfEnumeration getMatchingTerms()
    Gets the metadata highlight terms matching the query. All terms are lower case, with no duplicate. For example, these terms can be highlighted when displaying the result.
    Returns:
      The metadata highlight matching terms (IDfEnumeration of String). This enumeration can be empty.

  - ### getSummary

    String getSummary()
    Gets the metadata highlight summary.
    Returns:
      The metadata highlight summary.