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

Interface SlideOverFormAction<A extends SlideOverFormAction<A>>

All Superinterfaces:
Action<A>, Comparable<A>, Copyable<A>, Serializable
All Known Implementing Classes:
DefaultSlideOverFormAction
public interface SlideOverFormAction<A extends SlideOverFormAction<A>> extends Action<A>
Represents the metadata for the ResidentGridField.ActionTypes.CREATE_VIEW and ResidentGridField.ActionTypes.UPDATE_VIEW actions within an ResidentGridField. This component will use the SlideOverFormAction.FieldNames.COMPONENT_METADATA to define the form fields. This is the ID that defines pre-configured form fields. Typically, in the form of "catalog:product:create". This component can be configured with a field to provide the forms response (SlideOverFormAction.FieldNames.RESPONSE_FIELD_NAME). If not provided, the form response will be returned to the row.
Author:
Jon Fleschler (jfleschler)

  • Method Details

    • componentMetadata

      default A componentMetadata(String componentMetadata)

    • responseFieldName

      default A responseFieldName(String responseFieldName)
      Sets the field name for the response.
      Parameters:
      responseFieldName - the field name holding the response
      Returns:
      this

    • additionalFormState

      default A additionalFormState(String name)
      Adds an additional form state field to the action. This is used to pass additional state from the action to the form.
      Parameters:
      name - the field name of the additional form state and the source field name
      Returns:
      this
      Since:
      Metadata Services 2.0.7, Release Train 2.3.0

    • additionalFormState

      default A additionalFormState(String target, String source)
      Adds an additional form state field to the action. This is used to pass additional state from the action to the form.
      Parameters:
      target - the field name of the additional form state
      source - the field name of the field on the base form that holds the source value
      Returns:
      this
      Since:
      Metadata Services 2.0.7, Release Train 2.3.0

    • additionalResponseFields

      default A additionalResponseFields(Collection<String> additionalResponseFields)
      Adds additional response fields to the action. These fields will be included in the response of the form and can be used to pass additional data back to the caller.
      Parameters:
      additionalResponseFields - the collection of additional response field names
      Returns:
      this
      Since:
      Metadata Services 2.0.7, Release Train 2.3.0

    • addFormComponents

      default A addFormComponents(Collection<? extends FormComponent<?>> formComponents)

    • addField

      default A addField(String name, Field<?> field)

    • addField

      default A addField(Field<?> field)

    • addField

      default A addField(String name)

    • removeField

      default A removeField(String name)
      Removes a field with the given name.
      Parameters:
      name - the name of the field
      Returns:
      this

    • field

      default A field(String name, UnaryOperator<Field<?>> fn)
      Selects or creates a field with the given name and provides it as an argument to the function for further customization.
      Parameters:
      name - the name of the field
      fn - the customize function
      Returns:
      this

    • findField

      default Optional<Field<?>> findField(String name)

    • getField

      default Field<?> getField(String name)

    • addExternal

      default A addExternal(String id, External<?> external)

    • addExternal

      default A addExternal(External<?> external)

    • removeExternal

      default A removeExternal(String id)

    • external

      default A external(String id, UnaryOperator<External<?>> fn)

    • findExternal

      default Optional<External<?>> findExternal(String id)

    • getExternal

      default External<?> getExternal(String id)

    • addGroup

      default A addGroup(String id, Group<?> group)

    • addGroup

      default A addGroup(Group<?> group)

    • removeGroup

      default A removeGroup(String id)

    • group

      default A group(String id, UnaryOperator<Group<?>> fn)

    • findGroup

      default Optional<Group<?>> findGroup(String id)

    • getGroup

      default Group<?> getGroup(String id)