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

Interface ResidentMapCreateAction<A extends ResidentMapCreateAction<A>>

All Superinterfaces:

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

All Known Implementing Classes:

DefaultResidentMapCreateAction

public interface ResidentMapCreateAction<A extends ResidentMapCreateAction<A>>
extends ModalFormAction<A>

Represents the metadata for the ResidentMapField.ActionTypes#CREATE action within an ResidentMapField. This component is able to be configured with a field to provide the ResidentMapCreateAction.FieldNames.ENTRY_KEY. If not provided, a default of text input will be used.

Author:

Nick Crum (ncrum)

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ResidentMapCreateAction.FieldNames

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

ModalFormAction.Attributes

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

FormAction.Keys

Method Summary

Modifier and Type	Method and Description
default A	addEntryKeyField(Field<?> entryKeyField) Adds an entry key field to the action.
default A	entryKeyField(UnaryOperator<Field<?>> fn) Selects the entry key field for this action for further customization.
default Optional<Field<?>>	findEntryKeyField() Finds the entry key field.
default Field<?>	getEntryKeyField() Retrieves the entry key field.

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

submitLabel, submitLabel

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

Method Detail

addEntryKeyField

default A addEntryKeyField(Field<?> entryKeyField)

Adds an entry key field to the action.

Parameters:

entryKeyField - the field

Returns:

this

entryKeyField

default A entryKeyField(UnaryOperator<Field<?>> fn)

Selects the entry key field for this action for further customization.

Parameters:

fn - the function to customize

Returns:

this

getEntryKeyField

default Field<?> getEntryKeyField()

Retrieves the entry key field.

Returns:

the field

findEntryKeyField

default Optional<Field<?>> findEntryKeyField()

Finds the entry key field.

Returns:

an optional with the field, or empty