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

Interface LookupColumn<C extends LookupColumn<C>>

All Superinterfaces:

Column<C>, Comparable<C>, Component<C>, Copyable<C>, CustomCssComponent<C>, Serializable

All Known Implementing Classes:

DefaultLookupColumn

public interface LookupColumn<C extends LookupColumn<C>>
extends Column<C>

Represents the metadata for a ColumnTypes.LOOKUP.

Author:

Susana Cruz (susanaccruz)

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	LookupColumn.EndpointTypes

Nested classes/interfaces inherited from interface com.broadleafcommerce.metadata.dsl.core.Column

Column.ColumnAttributes

Field Summary

Fields inherited from interface com.broadleafcommerce.metadata.dsl.core.CustomCssComponent

CSS_ATTRIBUTE

Method Summary

Modifier and Type	Method	Description
default Optional<Endpoint<?>>	findHydrateEndpoint()
default Endpoint<?>	getHydrateEndpoint()
default C	hydrateEndpoint(Endpoint<?> endpoint)	Configures the hydration endpoint for the lookup.
default C	hydrateEndpoint(UnaryOperator<Endpoint<?>> fn)	Configures the hydration endpoint for the lookup.
default C	hydrateScope(String scope)	Configures hydrateEndpoint(UnaryOperator) url.
default C	hydrateUrl(String url)	Configures hydrateEndpoint(UnaryOperator) url.
default C	hydrateUrl(String url, String scope)	Configures hydrateEndpoint(UnaryOperator) url and scope.

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

addCellCssClass, addCellCssClass, addCellCssClass, addHeaderCssClass, addHeaderCssClass, addHeaderCssClass, align, alignCenter, alignLeft, alignRight, clearCellCssClasses, clearHeaderCssClasses, colSpan, colSpan, filterAndSortAlias, getAlign, getColSpan, getDataCellCssClasses, getHeaderCssClasses, getName, getWidth, isSortable, name, notSortable, removeCellCssClass, removeCellCssClass, removeCellCssClass, removeHeaderCssClass, removeHeaderCssClass, removeHeaderCssClass, setAlign, setColSpan, setName, setSortable, setWidth, sortable, sortable, width

Methods inherited from interface java.lang.Comparable

compareTo

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

addAction, addAction, addComponent, addEndpoint, addEndpoint, addSimpleComponent, apply, attribute, augmentable, augmentationKey, classifier, clearConditionals, clearEndpoints, conditional, conditionals, description, description, findAction, findAction, findActions, findAttribute, findAttribute, findComponent, findComponent, findComponents, findEndpoint, findEndpoint, findEndpoint, findEndpoints, get, get, getAction, getAction, getActions, getActionsList, getAttribute, getAttribute, getAttributes, getAugmentableFlag, 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, setAugmentable, 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

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

addCssClass, addCssClass, addCssClass, clearCssClasses, getCssClasses, removeCssClass, removeCssClass, removeCssClass

Method Details

hydrateEndpoint

default C hydrateEndpoint(Endpoint<?> endpoint)

Configures the hydration endpoint for the lookup. This endpoint tells the lookup where to go to retrieve the hydrated value of the column.

This is useful when the associated domain only stores an entity ID in the field value, but we wish to display additional entity information in the column.

Parameters:

endpoint - the hydrate endpoint

Returns:

this

hydrateEndpoint

default C hydrateEndpoint(UnaryOperator<Endpoint<?>> fn)

Configures the hydration endpoint for the lookup. This endpoint tells the lookup where to go to retrieve the hydrated value of the column.

This is useful when the associated domain only stores an entity ID in the field value, but we wish to display additional entity information in the column.

Parameters:

fn - a function to configure the hydrate endpoint

Returns:

this

hydrateUrl

default C hydrateUrl(String url)

Configures hydrateEndpoint(UnaryOperator) url.

Returns:

this

hydrateScope

default C hydrateScope(String scope)

Configures hydrateEndpoint(UnaryOperator) url.

Returns:

this

hydrateUrl

default C hydrateUrl(String url,
 String scope)

Configures hydrateEndpoint(UnaryOperator) url and scope.

Returns:

this

getHydrateEndpoint

default Endpoint<?> getHydrateEndpoint()

Returns:

the hydrate endpoint

findHydrateEndpoint

default Optional<Endpoint<?>> findHydrateEndpoint()

Returns:

an optional with hydrate endpoint, or empty