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

Interface GenerateTemplateAction<A extends GenerateTemplateAction<A>>

All Superinterfaces:

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

All Known Implementing Classes:

DefaultGenerateTemplateAction

public interface GenerateTemplateAction<A extends GenerateTemplateAction<A>>
extends ModalFormAction<A>

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	GenerateTemplateAction.Attributes
static class	GenerateTemplateAction.EndpointTypes
static class	GenerateTemplateAction.FieldDefaults
static class	GenerateTemplateAction.FieldLabels
static class	GenerateTemplateAction.FieldNames
static class	GenerateTemplateAction.GenerationType
static class	GenerateTemplateAction.KeyDefaults

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	addGenerationTypeSelect(SelectField<?> select)
default A	addTemplateGroupLookup(LookupField<?> templateGroup)	Adds the GenerateTemplateAction.FieldNames.TEMPLATE_GROUP field.
default A	addTemplateLookup(LookupField<?> template)	Adds the GenerateTemplateAction.FieldNames.TEMPLATE field.
default Optional<PageableEndpoint<?>>	findGenerationEndpoint()
default A	generationEndpoint(PageableEndpoint<?> endpoint)	Configure the generation endpoint for the lookup.
default A	generationEndpoint(UnaryOperator<PageableEndpoint<?>> fn)	Configure the generation endpoint for the lookup.
default A	generationScope(String scope)	Configures generationEndpoint(UnaryOperator) scope.
default A	generationTypeSelect(UnaryOperator<SelectField<?>> fn)
default A	generationUrl(String url)	Configures generationEndpoint(UnaryOperator) url.
default A	generationUrl(String url, String scope)	Configures generationEndpoint(UnaryOperator) url with scope
default PageableEndpoint<?>	getGenerationEndpoint()
default A	templateGroupLookup(UnaryOperator<LookupField<?>> fn)	Provides the GenerateTemplateAction.FieldNames.TEMPLATE_GROUP LookupField within this action's form for configuration.
default A	templateGroupTemplateKey(String templateGroupTemplateKey)
default A	templateLookup(UnaryOperator<LookupField<?>> fn)	Provides the GenerateTemplateAction.FieldNames.TEMPLATE LookupField within this action's form for configuration.
default A	templateToItemMapping(Mapping<?>... mappings)
default A	templateToItemMappings(List<Mapping<?>> mappings)

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 Detail

templateGroupTemplateKey

default A templateGroupTemplateKey(String templateGroupTemplateKey)

templateToItemMappings

default A templateToItemMappings(List<Mapping<?>> mappings)

templateToItemMapping

default A templateToItemMapping(Mapping<?>... mappings)

addTemplateLookup

default A addTemplateLookup(LookupField<?> template)

Adds the GenerateTemplateAction.FieldNames.TEMPLATE field.

Parameters:

template - the field

Returns:

the action

templateLookup

default A templateLookup(UnaryOperator<LookupField<?>> fn)

Provides the GenerateTemplateAction.FieldNames.TEMPLATE LookupField within this action's form for configuration. If no such field exists, one will be created.

Parameters:

fn - a function that configures the lookup field

Returns:

the action

addTemplateGroupLookup

default A addTemplateGroupLookup(LookupField<?> templateGroup)

Adds the GenerateTemplateAction.FieldNames.TEMPLATE_GROUP field.

Parameters:

templateGroup - the field

Returns:

the action

templateGroupLookup

default A templateGroupLookup(UnaryOperator<LookupField<?>> fn)

Provides the GenerateTemplateAction.FieldNames.TEMPLATE_GROUP LookupField within this action's form for configuration. If no such field exists, one will be created.

Parameters:

fn - a function that configures the lookup field

Returns:

the action

addGenerationTypeSelect

default A addGenerationTypeSelect(SelectField<?> select)

generationTypeSelect

default A generationTypeSelect(UnaryOperator<SelectField<?>> fn)

generationEndpoint

default A generationEndpoint(PageableEndpoint<?> endpoint)

Configure the generation endpoint for the lookup. This endpoint tells the lookup where it can go to retrieve the options the user chooses from. This endpoint is a PageableEndpoint and supports different paging strategies.

Parameters:

endpoint - the endpoint

Returns:

this

generationEndpoint

default A generationEndpoint(UnaryOperator<PageableEndpoint<?>> fn)

Configure the generation endpoint for the lookup. This endpoint tells the lookup where it can go to retrieve the options the user chooses from. This endpoint is a PageableEndpoint and supports different paging strategies.

Parameters:

fn - function to configure the endpoint

Returns:

this

generationUrl

default A generationUrl(String url)

Configures generationEndpoint(UnaryOperator) url.

Returns:

this

generationScope

default A generationScope(String scope)

Configures generationEndpoint(UnaryOperator) scope.

Returns:

this

generationUrl

default A generationUrl(String url,
                        String scope)

Configures generationEndpoint(UnaryOperator) url with scope

Returns:

this

getGenerationEndpoint

default PageableEndpoint<?> getGenerationEndpoint()

Returns:

the generation endpoint

findGenerationEndpoint

default Optional<PageableEndpoint<?>> findGenerationEndpoint()

Returns:

an optional with generation endpoint, or empty