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

Interface DateRangeField<F extends DateRangeField<F>>

All Superinterfaces:

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

All Known Implementing Classes:

DefaultDateRangeField

public interface DateRangeField<F extends DateRangeField<F>>
extends DateField<F>

Represents the metadata for a FieldTypes.DATE_RANGE field. This will take in start and end dates as attributes to render as a range.

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	DateRangeField.Attributes

Nested classes/interfaces inherited from interface com.broadleafcommerce.metadata.dsl.core.extension.fields.DateField

DateField.DateStartUnit

Method Summary

Modifier and Type	Method	Description
default F	dateRangeSeparator(String separator)	Adds the DateRangeField.Attributes.DATE_RANGE_SEPARATOR attribute.
default F	endDate(String date)	Adds the DateRangeField.Attributes.END_DATE attribute.
default Optional<String>	findDateRangeSeparator()	Finds the DateRangeField.Attributes.DATE_RANGE_SEPARATOR attribute.
default Optional<String>	findEndDate()	Finds the DateRangeField.Attributes.END_DATE attribute.
default Optional<String>	findStartDate()	Finds the DateRangeField.Attributes.START_DATE attribute.
default String	getDateRangeSeparator()	Gets the DateRangeField.Attributes.DATE_RANGE_SEPARATOR attribute.
default String	getEndDate()	Gets the DateRangeField.Attributes.END_DATE attribute.
default String	getStartDate()
default boolean	hasDateRangeSeparator()	Checks whether the DateRangeField.Attributes.DATE_RANGE_SEPARATOR attribute has been set.
default boolean	hasEndDate()	Checks whether the DateRangeField.Attributes.END_DATE attribute has been set.
default boolean	hasStartDate()	Checks whether the DateRangeField.Attributes.START_DATE attribute has been set.
default F	removeDateRangeSeparator()	Removes the DateRangeField.Attributes.DATE_RANGE_SEPARATOR attribute.
default F	removeEndDate()	Removes the DateRangeField.Attributes.END_DATE attribute.
default F	removeStartDate()	Removes the DateRangeField.Attributes.START_DATE attribute.
default F	startDate(String date)	Adds the DateRangeField.Attributes.START_DATE 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.extension.fields.DateField

computedFrom, dateFormat, defaultEndOf, defaultNow, defaultStartOf, findDateFormat, getComputedFromDate, getComputedFromDuration, getComputedFromDurationUnit, getDateFormat, hasComputedFromDate, hasComputedFromDuration, hasComputedFromDurationUnit, hasDateFormat, isComputedFrom, removeComputedFrom, removeDateFormat, validateIsAfter

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

startDate

default F startDate(String date)

Adds the DateRangeField.Attributes.START_DATE attribute.

Parameters:

date - the start date to set.

Returns:

this

getStartDate

@Nullable
default String getStartDate()

findStartDate

default Optional<String> findStartDate()

Finds the DateRangeField.Attributes.START_DATE attribute.

Returns:

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

removeStartDate

default F removeStartDate()

Removes the DateRangeField.Attributes.START_DATE attribute.

Returns:

this

hasStartDate

default boolean hasStartDate()

Checks whether the DateRangeField.Attributes.START_DATE attribute has been set.

Returns:

Whether the attribute is set.

endDate

default F endDate(String date)

Adds the DateRangeField.Attributes.END_DATE attribute.

Parameters:

date - the end date to set.

Returns:

this

getEndDate

@Nullable
default String getEndDate()

Gets the DateRangeField.Attributes.END_DATE attribute.

Returns:

the value of the attribute

findEndDate

default Optional<String> findEndDate()

Finds the DateRangeField.Attributes.END_DATE attribute.

Returns:

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

removeEndDate

default F removeEndDate()

Removes the DateRangeField.Attributes.END_DATE attribute.

Returns:

this

hasEndDate

default boolean hasEndDate()

Checks whether the DateRangeField.Attributes.END_DATE attribute has been set.

Returns:

Whether the attribute is set.

dateRangeSeparator

default F dateRangeSeparator(String separator)

Adds the DateRangeField.Attributes.DATE_RANGE_SEPARATOR attribute.

Parameters:

separator - The separator to set.

Returns:

this

getDateRangeSeparator

@Nullable
default String getDateRangeSeparator()

Gets the DateRangeField.Attributes.DATE_RANGE_SEPARATOR attribute.

Returns:

the value of the attribute

findDateRangeSeparator

default Optional<String> findDateRangeSeparator()

Finds the DateRangeField.Attributes.DATE_RANGE_SEPARATOR attribute.

Returns:

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

removeDateRangeSeparator

default F removeDateRangeSeparator()

Removes the DateRangeField.Attributes.DATE_RANGE_SEPARATOR attribute.

Returns:

this

hasDateRangeSeparator

default boolean hasDateRangeSeparator()

Checks whether the DateRangeField.Attributes.DATE_RANGE_SEPARATOR attribute has been set.

Returns:

Whether the attribute is set.