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>

  • Method Details

    • 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

    • addPreferAddTemplateByReferenceSelect

      default A addPreferAddTemplateByReferenceSelect(SelectField<?> select)

    • preferAddTemplateByReferenceSelect

      default A preferAddTemplateByReferenceSelect(UnaryOperator<SelectField> fn)

    • addGenerationTypeSelect

      default A addGenerationTypeSelect(SelectField<?> select)

    • generationTypeSelect

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

    • sandboxDiscriminated

      default A sandboxDiscriminated(Boolean sandboxDiscriminated)

    • 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