Package com.broadleafcommerce.search.api.domain

Class FieldRef

java.lang.Object
com.broadleafcommerce.search.api.domain.FieldRef
All Implemented Interfaces:
Serializable
public class FieldRef extends Object implements Serializable
DTO for holding field definition data.
See Also:

  • Constructor Details

    • FieldRef

      public FieldRef()

  • Method Details

    • getId

      public String getId()
      The context ID of the field.
      Returns:
      the context ID of the field

    • getLabel

      public String getLabel()
      The label of the field, suitable for display.
      Returns:
      label for the field, suitable for display

    • getIndexableType

      public String getIndexableType()
      The type to which this field belongs. Populated by IndexableType type.
      Returns:
      type to which this field belongs

    • getAbbreviation

      public String getAbbreviation()
      Short field name which will be used for request parameters for example in sorting and filtering, as well as response field names.
      Returns:
      short name for request and response field name

    • isTranslatable

      public boolean isTranslatable()
      Indicates if this field is translatable.
      Returns:
      whether this field is translatable

    • setId

      public void setId(String id)
      The context ID of the field.
      Parameters:
      id - the context ID of the field

    • setLabel

      public void setLabel(String label)
      The label of the field, suitable for display.
      Parameters:
      label - label for the field, suitable for display

    • setIndexableType

      public void setIndexableType(String indexableType)
      The type to which this field belongs. Populated by IndexableType type.
      Parameters:
      indexableType - type to which this field belongs

    • setAbbreviation

      public void setAbbreviation(String abbreviation)
      Short field name which will be used for request parameters for example in sorting and filtering, as well as response field names.
      Parameters:
      abbreviation - short name for request and response field name

    • setTranslatable

      public void setTranslatable(boolean translatable)
      Indicates if this field is translatable.
      Parameters:
      translatable - whether this field is translatable

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object