Package org.nuclos.api.context

Interface InputDelegate

public interface InputDelegate
Interface for creating input delegate views. Interface is required for data exchange between InputDelegate implementation and the nuclos core.
Author:
thomas.schiffmann

  • Method Summary

    Modifier and Type
    Method
    Description
    default void
    close()
    Close the input delegate view, this will be called before the dialog is being closed.
    Map<String,Serializable>
    evaluate()
    Validate and collect data from input components.
    JPanel
    initialize(Map<String,Serializable> data)
    Initialize the input delegate view with optional context data from server.
    default void
    setCompletionConsumer(Consumer<Boolean> completionConsumer)
    A "Completion Consumer" can be optionally usedm by whom the implemenation can notify when input is (in)complete.

  • Method Details

    • initialize

      JPanel initialize(Map<String,Serializable> data)
      Initialize the input delegate view with optional context data from server.
      Parameters:
      data - Context data from server or rule (optional)
      Returns:
      The JPanel with the input components the user will see.

    • evaluate

      Map<String,Serializable> evaluate() throws InputValidationException
      Validate and collect data from input components.
      Returns:
      Collected data as map of strings (key) and serializables.
      Throws:
      InputValidationException - If user input is incomplete or entered values are invalid.

    • close

      default void close()
      Close the input delegate view, this will be called before the dialog is being closed. It is an optional possibility to clean up stuff.

    • setCompletionConsumer

      default void setCompletionConsumer(Consumer<Boolean> completionConsumer)
      A "Completion Consumer" can be optionally usedm by whom the implemenation can notify when input is (in)complete. E.g. the notification can be used to disable/enable an "Ok"-Button.