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

Interface MoneyField<F extends MoneyField<F>>

All Superinterfaces:

Comparable<F>, Component<F>, Copyable<F>, Field<F>, FormComponent<F>, Serializable

All Known Implementing Classes:

DefaultMoneyField

public interface MoneyField<F extends MoneyField<F>>
extends Field<F>

Represents the metadata for a FieldTypes.MONEY field component. 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	Description
static final class	MoneyField.Attributes

Method Summary

Modifier and Type	Method	Description
default F	complexValue()	Sets the value of MoneyField.Attributes.SIMPLE_VALUE to false.
default F	currencyCodeField(String currencyCodeField)
default F	simpleValue()	Sets the value of MoneyField.Attributes.SIMPLE_VALUE to true.
default F	simpleValue(boolean isSimpleValue)	Sets the value of MoneyField.Attributes.SIMPLE_VALUE.

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.Field

clearReadOnlyConditionals, decorated, decorated, defaultValue, displayOnly, displayOnly, getDefaultValue, getMaxLength, getName, getPlaceholder, getReadOnlyConditionals, getRequiredMessage, getValidationSchema, isReadOnly, isRequired, isShowInQueryBuilder, isTargetCollection, maxLength, name, noMaxLength, notReadOnly, notRequired, placeholder, placeholder, readOnly, readOnly, readOnlyConditional, readOnlyConditionals, required, required, required, required, requiredMessage, requiredMessage, setDefaultValue, setMaxLength, setName, setPlaceholder, setReadOnly, setReadOnlyConditionals, setRequired, setRequiredMessage, setShowInQueryBuilder, setValidationSchema, targetIsCollection, targetIsNotCollection, validationMethod, validationSchema, validationSchema

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

getHelpText, getHint, getTooltip, helpText, helpText, helpText, hidden, hidden, hint, hint, isHidden, notHidden, setHelpText, setHidden, setHint, setTooltip, tooltip, tooltip

Method Details

currencyCodeField

default F currencyCodeField(String currencyCodeField)

simpleValue

default F simpleValue(boolean isSimpleValue)

Sets the value of MoneyField.Attributes.SIMPLE_VALUE.

Parameters:

isSimpleValue - The value to set

Returns:

this

Since:

Metadata 2.0.8, Release Train 2.1.6

simpleValue

default F simpleValue()

Sets the value of MoneyField.Attributes.SIMPLE_VALUE to true.

Returns:

this

Since:

Metadata 2.0.8, Release Train 2.1.6

complexValue

default F complexValue()

Sets the value of MoneyField.Attributes.SIMPLE_VALUE to false.

Returns:

this

Since:

Metadata 2.0.8, Release Train 2.1.6