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

Interface DurationField<F extends DurationField<F>>

All Superinterfaces:

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

All Known Implementing Classes:

DefaultDurationField

public interface DurationField<F extends DurationField<F>>
extends Field<F>

Represents the metadata for a duration field.

Since:

Metadata Service 2.0.8, Release Train 2.1.6

Author:

Susana Cruz (susanaccruz)

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	DurationField.Attributes

Method Summary

Modifier and Type	Method	Description
default F	baseUnits(String baseUnits)	Adds the DurationField.Attributes.BASE_UNITS attribute.
default Optional<String>	findBaseUnits()	Finds the DurationField.Attributes.BASE_UNITS attribute.
default String	getBaseUnits()
default boolean	hasBaseUnits()	Checks whether the DurationField.Attributes.BASE_UNITS attribute has been set.
default F	removeBaseUnits()	Removes the DurationField.Attributes.BASE_UNITS attribute.

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

baseUnits

default F baseUnits(String baseUnits)

Adds the DurationField.Attributes.BASE_UNITS attribute.

Parameters:

baseUnits - the base units to set.

Returns:

this

getBaseUnits

@Nullable
default String getBaseUnits()

findBaseUnits

default Optional<String> findBaseUnits()

Finds the DurationField.Attributes.BASE_UNITS attribute.

Returns:

the value of the attribute or Optional.empty() if not present.

removeBaseUnits

default F removeBaseUnits()

Removes the DurationField.Attributes.BASE_UNITS attribute.

Returns:

this

hasBaseUnits

default boolean hasBaseUnits()

Checks whether the DurationField.Attributes.BASE_UNITS attribute has been set.

Returns:

Whether the attribute is set.