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

Interface CreateModalFormAction<A extends CreateModalFormAction<A>>

All Superinterfaces:

Action<A>, Comparable<A>, Copyable<A>, FormAction<A>, ModalFormAction<A>, Serializable

All Known Implementing Classes:

DefaultCreateModalFormAction

public interface CreateModalFormAction<A extends CreateModalFormAction<A>>
extends ModalFormAction<A>

Extension of ModalFormAction that is used for the creation of new entities.

Adds guidance on configuring CreateModalFormAction.Attributes.MAP_INHERITED_VALUES for create modal form actions.

Author:

Nick Crum (ncrum)

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CreateModalFormAction.Attributes

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

FormAction.Keys

Method Summary

Modifier and Type	Method	Description
default A	mapInheritedValue(Mapping<?>... mappingsToAdd)	Configure mappings from the parent data to the create form's state.
default A	mapInheritedValues(Collection<Mapping<?>> mappingsToAdd)	Configure mappings from the parent data to the create form's state.

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

addComponent, addComponents, addEndpoint, addEndpoint, apply, attribute, clearEndpoints, findAttribute, findComponent, findComponent, findComponents, findEndpoint, findEndpoint, findEndpoints, get, get, getAttribute, getAttribute, getAttributes, getComponent, getComponent, getComponents, getComponentsList, getEndpoint, getEndpoint, getEndpoints, getEndpointsList, getId, getLabel, getOperationType, getOrder, getPlacement, getScope, getType, hasAttribute, hasComponent, hasEndpoint, id, label, label, operationType, order, placement, removeAttribute, removeComponent, removeEndpoint, scope, self, setAttributes, setComponents, setEndpoints, setId, setLabel, setOperationType, setOrder, setPlacement, setScope, setType, type

Methods inherited from interface java.lang.Comparable

compareTo

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

copy

Methods inherited from interface com.broadleafcommerce.metadata.dsl.core.extension.actions.FormAction

addExternal, addExternal, addField, addField, addField, addFormComponents, addGroup, addGroup, external, field, findExternal, findField, findGroup, getExternal, getField, getGroup, group, removeExternal, removeField, removeGroup

Methods inherited from interface com.broadleafcommerce.metadata.dsl.core.extension.actions.ModalFormAction

submitLabel, submitLabel

Method Details

mapInheritedValue

default A mapInheritedValue(Mapping<?>... mappingsToAdd)

Configure mappings from the parent data to the create form's state. This is used in order to ensure the creation of an object inherits certain values from the parent, for example:

 // maps the parent form's "id" to the "productId" field in the create form
 action.mapInheritedValue(Mappings.mapValue("id", "productId");
 

Parameters:

mappingsToAdd - the mappings to add

Returns:

the action

mapInheritedValues

default A mapInheritedValues(Collection<Mapping<?>> mappingsToAdd)

Configure mappings from the parent data to the create form's state. This is used in order to ensure the creation of an object inherits certain values from the parent.

Parameters:

mappingsToAdd - the mappings to add

Returns:

the action

See Also:

• for more details