Package formflow.library.config.submission

Interface Action

public interface Action
An interface to define a particular Action.

  • Method Summary

    Modifier and Type
    Method
    Description
    default void
    run(FormSubmission formSubmission, Submission submission)
    Runs an action on form submission and submission data to potentially manipulate the data.
    default void
    run(FormSubmission formSubmission, Submission submission, String id)
    Runs an action on form submission and submission data to potentially manipulate the data.
    default void
    run(Submission submission)
    Runs an action on a submission to potentially manipulate the data.
    default void
    run(Submission submission, String id)
    Runs an action on a submission to potentially manipulate the data.
    default Map<String,List<String>>
    runValidation(FormSubmission formSubmission)
    Deprecated.
    use `runValidation(final FormSubmission formSubmission, Submission submission)` instead.
    default Map<String,List<String>>
    runValidation(FormSubmission formSubmission, Submission submission)
    Runs validation code with the expectation that error messages may be returned.

  • Method Details

    • run

      default void run(Submission submission)
      Runs an action on a submission to potentially manipulate the data.
      Parameters:
      submission - submission object the action is associated with, not null

    • run

      default void run(Submission submission, String id)
      Runs an action on a submission to potentially manipulate the data.
      Parameters:
      submission - submission object the action is associated with, not null
      id - id for the iteration

    • run

      default void run(FormSubmission formSubmission, Submission submission)
      Runs an action on form submission and submission data to potentially manipulate the data.
      Parameters:
      formSubmission - form submission object the action is associated with, not null
      submission - submission object the action is associated with, not null

    • run

      default void run(FormSubmission formSubmission, Submission submission, String id)
      Runs an action on form submission and submission data to potentially manipulate the data.
      Parameters:
      formSubmission - form submission object the action is associated with, not null
      submission - submission object the action is associated with, not null
      id - id for the iteration

    • runValidation

      @Deprecated default Map<String,List<String>> runValidation(FormSubmission formSubmission)
      Deprecated.
      use `runValidation(final FormSubmission formSubmission, Submission submission)` instead.
      Runs validation code with the expectation that error messages may be returned.
      Parameters:
      formSubmission - form submission object the action is associated with, not null
      Returns:
      a hashmap of a String to List of Strings that represents errors and their corresponding error messages.

    • runValidation

      default Map<String,List<String>> runValidation(FormSubmission formSubmission, Submission submission)
      Runs validation code with the expectation that error messages may be returned.
      Parameters:
      formSubmission - form submission object the action is associated with, not null
      submission - submission object the action is associated with, not null
      Returns:
      a hashmap of a String to List of Strings that represents errors and their corresponding error messages.