Package com.broadleafcommerce.metadata.dsl.core.extension.views

Interface SelectTargetEntityGridView<V extends SelectTargetEntityGridView<V>>

All Superinterfaces:
Comparable<V>, Component<V>, Copyable<V>, CustomCssComponent<V>, FetchGrid<V>, Filterable<V>, FilterableGrid<V>, Grid<V>, Selectable<V>, Serializable, SortableGrid<V>, Trackable<V>, View<V>
All Known Implementing Classes:
DefaultSelectTargetEntityGridView
public interface SelectTargetEntityGridView<V extends SelectTargetEntityGridView<V>> extends FetchGrid<V>, FilterableGrid<V>, SortableGrid<V>, Selectable<V>, View<V>, Trackable<V>
This grid is used to fetch and display the entities to export.
Author:
Dima Myroniuk (dmyroniuk)

  • Method Details

    • getHelpText

      ExplanatoryMessage getHelpText()

      Additional information that can be displayed from a clickable popup from a (?) or (!) icon displaying next to the component

      This value is translatable and can be a key that maps into a message bundle

      Returns:
      the help text

    • getHint

      InternationalizedMessage getHint()

      Displays as text next to the field with information about how a user should fill it out. This is always visible when rendering the field

      This value is translatable and can be a key that maps into a message bundle

      Returns:
      the hint

    • setHelpText

      void setHelpText(ExplanatoryMessage helpText)

    • setHint

      void setHint(InternationalizedMessage hint)

    • helpText

      default V helpText(String helpText)

    • helpText

      default V helpText(String helpText, ExplanatoryMessage.Type type)

    • helpText

      default V helpText(ExplanatoryMessage helpText)

    • hint

      default V hint(String hint)

    • hint

      default V hint(InternationalizedMessage hint)

    • readTargetEntitiesEndpoint

      default V readTargetEntitiesEndpoint(UnaryOperator<PageableEndpoint<?>> fn)
      Adds the endpoint to read the entities.
      Parameters:
      fn - the function to customize the endpoint
      Returns:
      this grid for further customization

    • filterTargetEntities

      @Deprecated(since="2.0.3") default V filterTargetEntities(UnaryOperator<QueryBuilderFilterAction<?>> fn)
      Deprecated.
      since 2.0.3, in favor of filterTargetEntitiesField(UnaryOperator, boolean).
      Adds the filter action to have an ability to filter the entities in the grid.
      Parameters:
      fn - the function to customize the action
      Returns:
      this grid for further customization

    • filterTargetEntitiesField

      default V filterTargetEntitiesField(UnaryOperator<QueryBuilderField<?>> fn, boolean passFilterStringAsParam)
      Adds the filter field to have an ability to filter the entities in the grid.
      Parameters:
      fn - the function to customize the field
      passFilterStringAsParam - the boolean to determine whether the filter string from the query builder should be passed as part of a request's parameters or in the request body
      Returns:
      this grid for further customization

    • selectCatalogFieldLabel

      default V selectCatalogFieldLabel(String label)
      Sets the label for the catalog selector field.
      Parameters:
      label - the message key for the catalog selector field label
      Returns:
      this grid for further customization

    • selectCatalogFieldPlaceholder

      default V selectCatalogFieldPlaceholder(String placeholder)
      Sets the placeholder for the catalog selector field.
      Parameters:
      placeholder - the message key for the catalog selector field placeholder
      Returns:
      this grid for further customization

    • selectSandboxFieldLabel

      default V selectSandboxFieldLabel(String label)
      Sets the label for the sandbox selector field.
      Parameters:
      label - the message key for the sandbox selector field label
      Returns:
      this grid for further customization

    • selectSandboxFieldPlaceholder

      default V selectSandboxFieldPlaceholder(String placeholder)
      Sets the placeholder for the sandbox selector field.
      Parameters:
      placeholder - the message key for the sandbox selector field placeholder
      Returns:
      this grid for further customization

    • passFilterStringAsParam

      default V passFilterStringAsParam(boolean passFilterStringAsParam)
      Whether the filter string to be used in a request will be passed as a parameter or as part of the request body.
      Parameters:
      passFilterStringAsParam - whether to pass the filter as a parameter or in the request body
      Returns:
      this grid for further customization