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

Interface MoneyColumn<C extends MoneyColumn<C>>

All Superinterfaces:

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

All Known Implementing Classes:

DefaultMoneyColumn

public interface MoneyColumn<C extends MoneyColumn<C>>
extends Column<C>

Represents the metadata for a column that displays a monetary amount. It is expected that this field targets a money object, and not a big decimal, for example:

 {
     "defaultPrice": {
         "amount": 10,
         "currency": "USD"
     }
 }
 

Author:

Nick Crum (ncrum)

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	MoneyColumn.Attributes

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

Column.ColumnAttributes

Method Summary

Modifier and Type	Method and Description
default C	currencyCodeField(String currencyCodeField) Sets the name of the property with the currency that should be used when formatting the amount.

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

align, alignCenter, alignLeft, alignRight, colSpan, colSpan, filterAndSortAlias, getAlign, getColSpan, getName, getWidth, isSortable, name, notSortable, setAlign, setColSpan, setName, setSortable, setWidth, sortable, sortable, width

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 java.lang.Comparable

compareTo

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

copy

Method Detail

currencyCodeField

default C currencyCodeField(String currencyCodeField)

Sets the name of the property with the currency that should be used when formatting the amount. If no currency code field is defined, then this component will look at the `currency` on the money object.

Parameters:

currencyCodeField - the currency code field

Returns:

this