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

Interface ComputedField<F extends ComputedField<F>>

All Superinterfaces:

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

All Known Implementing Classes:

DefaultComputedField

public interface ComputedField<F extends ComputedField<F>>
extends Field<F>

Represents the metadata for a field whose value will be computed from other form field values.

This field is always displayed as read-only, and by default has Field.displayOnly() set to true to display the field value as a plain or raw text representation.

Since:

Metadata Service 2.0.8, Release Train 2.1.6, 2.2.2

Author:

Julia Lopez-Pozas (jlopezpozas)

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	ComputedField.Attributes
static final class	ComputedField.ComputationTypes

Method Summary

Modifier and Type	Method	Description
default F	computationType(String computationType)	The type of computation that this field will result in.
default F	fieldsToCompute(String... fieldsToCompute)	The list of field names whose values this field will use to compute.
default F	fieldsToCompute(List<String> fieldsToCompute)	The list of field names whose values this field will use to compute.

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

computationType

default F computationType(String computationType)

The type of computation that this field will result in.

This should match any of the defined ComputationTypes.

Parameters:

computationType - the type of computation that this field will result in

Returns:

this

fieldsToCompute

default F fieldsToCompute(List<String> fieldsToCompute)

The list of field names whose values this field will use to compute.

The fields to compute must have values that are numeric, such as MoneyField and IntegerField.

The order of the fields listed will be the order they are operated on.

Parameters:

fieldsToCompute - a list of field names whose values will be computed

Returns:

this

fieldsToCompute

default F fieldsToCompute(String... fieldsToCompute)

The list of field names whose values this field will use to compute.

The fields to compute must have values that are numeric, such as MoneyField and IntegerField.

The order of the fields listed will be the order they are operated on.

Parameters:

fieldsToCompute - a variable number of field names whose values will be computed

Returns:

this