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

Interface ExternalFieldGroup<G extends ExternalFieldGroup<G>>

All Superinterfaces:

Comparable<G>, Component<G>, Copyable<G>, External<G>, FetchEntity<G>, Form<G>, FormComponent<G>, Group<G>, Serializable

All Known Implementing Classes:

DefaultExternalFieldGroup

public interface ExternalFieldGroup<G extends ExternalFieldGroup<G>>
extends Group<G>, External<G>, FetchEntity<G>

Renders a group of form components whose values are derived from a separate API from the parent form.

When using this component, a READ endpoint should be configured in the group so that the form component values can be fetched, and an UPDATE endpoint should be configured in the parent form that contains this group component to update the external source or entity.

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

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

FetchEntity.EndpointTypes

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

Form.Keys

Method Summary

Modifier and Type	Method	Description
default G	useParentFormState()	Convenience method that is the same as treatAsPatch(true).
default G	useParentFormState(boolean useParentFormState)	Indicates that the state for the fields in this group will be backed by the parent form's.

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

clearReadOnlyConditionals, getReadOnlyConditionals, isReadOnly, notReadOnly, readOnly, readOnly, readOnlyConditional, readOnlyConditionals, setReadOnly, setReadOnlyConditionals

Methods inherited from interface com.broadleafcommerce.metadata.dsl.core.extension.FetchEntity

addReadEndpoint, findReadEndpoint, getReadEndpoint, readEndpoint, readScope, readUrl, readUrl

Methods inherited from interface com.broadleafcommerce.metadata.dsl.core.extension.Form

addExternal, addExternal, addField, addField, addField, addFields, addFormComponents, addGroup, addGroup, addMessage, addMessage, external, field, findExternal, findField, findGroup, findMessage, getExternal, getField, getGroup, getMessage, group, message, removeExternal, removeField, removeGroup, removeMessage

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

useParentFormState

default G useParentFormState(boolean useParentFormState)

Indicates that the state for the fields in this group will be backed by the parent form's.

Parameters:

useParentFormState - Whether to use the parent form's state

Returns:

this

See Also:

• ExternalFieldGroup.Attributes.USE_PARENT_FORM_STATE

useParentFormState

default G useParentFormState()

Convenience method that is the same as treatAsPatch(true).

Returns:

this