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

Interface CloneModalFormAction<A extends CloneModalFormAction<A>>

All Superinterfaces:
Action<A>, Comparable<A>, ConditionalAction<A>, Copyable<A>, FormAction<A>, ModalFormAction<A>, Serializable
All Known Implementing Classes:
DefaultCloneModalFormAction
public interface CloneModalFormAction<A extends CloneModalFormAction<A>> extends ModalFormAction<A>
Extension of ModalFormAction that is used for the cloning of new entities.
Author:
Nick Crum (ncrum)

  • Method Details

    • addCloneEndpoint

      default A addCloneEndpoint(Endpoint<?> endpoint)
      Adds the CloneModalFormAction.EndpointTypes.CLONE endpoint for the component.
      Parameters:
      endpoint - the endpoint
      Returns:
      this

    • cloneEndpoint

      default A cloneEndpoint(UnaryOperator<Endpoint<?>> fn)
      Configures the CloneModalFormAction.EndpointTypes.CLONE endpoint for the component.
      Parameters:
      fn - the function to configure the endpoint
      Returns:
      this

    • cloneUrl

      default A cloneUrl(String url)
      Configures the CloneModalFormAction.EndpointTypes.CLONE endpoint with the given url.
      Parameters:
      url - the url
      Returns:
      this

    • cloneScope

      default A cloneScope(String scope)
      Configures the CloneModalFormAction.EndpointTypes.CLONE endpoint with the given scope.
      Parameters:
      scope - the scope
      Returns:
      this

    • cloneUrl

      default A cloneUrl(String url, String scope)
      Configures the CloneModalFormAction.EndpointTypes.CLONE endpoint with the given url and scope.
      Parameters:
      url - the url
      scope - the scope
      Returns:
      this

    • getCloneEndpoint

      default Endpoint<?> getCloneEndpoint()
      Retrieves the CloneModalFormAction.EndpointTypes.CLONE endpoint for this component.
      Returns:
      the endpoint if it exists
      See Also:

    • findCloneEndpoint

      default Optional<Endpoint<?>> findCloneEndpoint()
      Finds the CloneModalFormAction.EndpointTypes.CLONE endpoint for this component.
      Returns:
      an optional with the endpoint, or empty

    • redirectLink

      default A redirectLink(Link link)
      Defines a redirect to occur following a successful clone operation.
      Parameters:
      link - the link to redirect to
      Returns:
      this

    • redirectLinkByPath

      default A redirectLinkByPath(String path)
      Defines a redirect to occur following a successful clone operation.
      Parameters:
      path - the path to redirect to
      Returns:
      this

    • redirectLinkById

      default A redirectLinkById(String componentId)
      Defines a redirect to occur following a successful clone operation.
      Parameters:
      componentId - the id of the component to redirect to
      Returns:
      this

    • transformClone

      default A transformClone(Mapping<?>... mappings)
      Configure a set of Mapping to transform the cloned entity.

      A common use case is to transform the name of an entity, for example: 

       cloneAction.transformClone(Mappings.templateTransform("name", "Clone of ${name}"));
      Returns:
      this

    • transformClone

      default A transformClone(List<Mapping<?>> mappings)
      Configure a set of Mapping to transform the cloned entity.

      A common use case is to transform the name of an entity, for example: 

       cloneAction.transformClone(
         Arrays.asList(Mappings.templateTransform("name", "Clone of ${name}")));
      Returns:
      this

    • transformClone

      default A transformClone(UnaryOperator<List<Mapping<?>>> fn)
      Configure a set of Mapping to transform the cloned entity.

      A common use case is to transform the name of an entity, for example: 

       cloneAction.transformClone(
         mappings -> mappings.add(Mappings.templateTransform("name", "Clone of ${name}")));
      Returns:
      this