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)

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	Pollable.Attributes

Method Summary

Modifier and Type	Method	Description
default G	notPollable()	Disables pollable behavior.
default G	pollable()	Enables pollable behavior with out-of-box defaults.
default G	pollable(boolean isPollable)
default G	pollable(UnaryOperator<Pollable<?>> fn)	Configure polling behavior for the component.
default G	pollableCollectionCondition(Conditional<?>... conditions)
default G	pollableCollectionConditions(Collection<Conditional<?>> conditionsToAdd)
default G	pollableItemCondition(Conditional<?>... conditions)
default G	pollableItemConditions(Collection<Conditional<?>> conditionsToAdd)
default G	pollableOptions(PollableOptions pollOptions)
default G	pollableOptions(UnaryOperator<PollableOptions> fn)	Enables pollable behavior and provides the opportunity to configure the PollableOptions.

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface com.broadleafcommerce.metadata.dsl.core.Component

addAction, addAction, addComponent, addEndpoint, addEndpoint, apply, attribute, augmentationKey, classifier, clearConditionals, clearEndpoints, conditional, conditionals, description, description, findAction, findAction, findActions, findAttribute, findComponent, findComponent, findComponents, findEndpoint, findEndpoint, findEndpoints, get, get, getAction, getAction, getActions, getActionsList, getAttribute, getAttribute, getAttributes, getAugmentationKey, getClassifier, getComponent, getComponent, getComponents, getComponentsList, getConditionals, getDescription, getEndpoint, getEndpoint, getEndpoints, getEndpointsList, getId, getLabel, getOrder, getScope, getType, hasAction, hasAttribute, hasComponent, hasEndpoint, id, isAugmentable, isTranslatable, label, label, notTranslatable, order, removeAction, removeAttribute, removeComponent, removeEndpoint, scope, self, setActions, setAttributes, setAugmentationKey, setClassifier, setComponents, setConditionals, setDescription, setEndpoints, setId, setLabel, setOrder, setScope, setTranslatable, setType, translatable, translatable, type

Methods inherited from interface com.broadleafcommerce.metadata.dsl.core.Copyable

copy

Method Detail

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)