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

Interface Pollable<G extends Pollable<G>>

All Superinterfaces:
Comparable<G>, Component<G>, Copyable<G>, Serializable
All Known Subinterfaces:
EntityGridView<V>, ExportHistoryEntityGridView<V>, ExportHistoryGrid<G>, ExportHistoryGridExternal<E>, GridExternal<E>, GridView<V>, TreeGridView<V>
All Known Implementing Classes:
DefaultEntityGridView, DefaultExportHistoryEntityGridView, DefaultExportHistoryGridExternal, DefaultGridExternal, DefaultTreeGridView
public interface Pollable<G extends Pollable<G>> extends Component<G>
An interface implemented by components that intend to support pollable behavior.
Author:
Nick Crum (ncrum)

  • Method Details

    • pollable

      default G pollable(UnaryOperator<Pollable<?>> fn)
      Configure polling behavior for the component. This is generally used with a lambda function, for example: 
       grid.pollable(pollable -> pollable
         .pollableOptions(options -> options
                 .errorLimit(5)
                 .constantStrategy(5000)));
      Parameters:
      fn - the function to configure the pollable component
      Returns:
      the pollable

    • pollable

      default G pollable(boolean isPollable)

    • pollable

      default G pollable()
      Enables pollable behavior with out-of-box defaults.
      Returns:
      the pollable

    • notPollable

      default G notPollable()
      Disables pollable behavior.
      Returns:
      the pollable

    • pollableOptions

      default G pollableOptions(PollableOptions pollOptions)

    • pollableOptions

      default G pollableOptions(UnaryOperator<PollableOptions> fn)
      Enables pollable behavior and provides the opportunity to configure the PollableOptions.
      Parameters:
      fn - the function to configure the poll options
      Returns:
      the pollable

    • pollableCollectionConditions

      default G pollableCollectionConditions(Collection<Conditional<?>> conditionsToAdd)

    • pollableCollectionCondition

      default G pollableCollectionCondition(Conditional<?>... conditions)

    • pollableItemConditions

      default G pollableItemConditions(Collection<Conditional<?>> conditionsToAdd)

    • pollableItemCondition

      default G pollableItemCondition(Conditional<?>... conditions)