Interface Associate


public interface Associate
Definition of an associate for adding to some index.
Since:
5.2.12
  • Method Summary

    Modifier and Type
    Method
    Description
    Provides the form data to be indexed for this associate.
    Provides the term to be written identifying the associate in the index.
    Provides the associate's type.
  • Method Details

    • getType

      @NotNull Object getType()
      Provides the associate's type.
      Returns:
      The type of the associate.
      Since:
      5.2.12
    • getIndexTerm

      @NotNull String getIndexTerm()
      Provides the term to be written identifying the associate in the index.
      Returns:
      The index term.
      Since:
      5.2.12
    • getFormData

      @Nullable FormData getFormData()
      Provides the form data to be indexed for this associate.
      Returns:
      The form data or null, if no data is to be indexed.
      Since:
      5.2.12