Package org.nuclos.api.context

Class InputSpecification

java.lang.Object
org.nuclos.api.context.InputSpecification
All Implemented Interfaces:
Serializable
public class InputSpecification extends Object implements Serializable
Specification of input dialog.
Author:
thomas.schiffmann
See Also:

  • Field Details

    • CONFIRM_YES_NO

      public static final int CONFIRM_YES_NO
      Input type to show a yes/no dialog.
      See Also:

    • CONFIRM_OK_CANCEL

      public static final int CONFIRM_OK_CANCEL
      Input type to show a ok/cancel dialog. If the user choosed cancel, the request won't execute again.
      See Also:

    • CONFIRM_OK

      public static final int CONFIRM_OK
      Input type to show a ok dialog.
      See Also:

    • OK

      public static final int OK
      Variable value for ok.
      See Also:

    • YES

      public static final int YES
      Variable value for yes.
      See Also:

    • NO

      public static final int NO
      Variable value for no.
      See Also:

    • INPUT_VALUE

      public static final int INPUT_VALUE
      Input type to show string input dialog.
      See Also:

    • INPUT_MEMO

      public static final int INPUT_MEMO
      Input type to show string memo input dialog (with text area and possibility to enter a line break)
      See Also:

    • INPUT_OPTION

      public static final int INPUT_OPTION
      Input type to show a select option dialog.
      See Also:

  • Constructor Details

    • InputSpecification

      protected InputSpecification()
      for deserialization only

    • InputSpecification

      public InputSpecification(int type, String key, String message)
      Create a new InputSpecification
      Parameters:
      type - Input type (CONFIRM_YES_NO, CONFIRM_OK_CANCEL, INPUT_VALUE or INPUT_OPTION)
      key - Variable key (to obtain the value)
      message - Dialog message

    • InputSpecification

      public InputSpecification(int type, String key, String message, String title)
      Create a new InputSpecification
      Parameters:
      type - Input type (CONFIRM_YES_NO, CONFIRM_OK_CANCEL, INPUT_VALUE or INPUT_OPTION)
      key - Variable key (to obtain the value)
      message - Dialog message
      title - Dialog title

  • Method Details

    • getType

      public int getType()
      Get input type.
      Returns:
      Input type

    • getKey

      public String getKey()
      Get the variable key/name.
      Returns:
      Variable key/name

    • getMessage

      public String getMessage()
      Get the dialog message.
      Returns:
      Dialog message

    • getTitle

      public String getTitle()
      Get the dialog title.
      Returns:
      Dialog title

    • getOptions

      public Object[] getOptions()
      Get available input options, only applicable for INPUT_OPTION.
      Returns:
      Input options

    • setOptions

      public void setOptions(Object[] options)
      Set available input options, only applicable for INPUT_OPTION.
      Parameters:
      options - Available input options

    • getDefaultOption

      public Object getDefaultOption()
      Get default option (of available options, only applicable for INPUT_OPTION)
      Returns:
      Default option.

    • setDefaultOption

      public void setDefaultOption(Object defaultOption)
      Set default option (of available options, only applicable for INPUT_OPTION)
      Parameters:
      defaultOption - Default option

    • applyForAllMultiEditObjects

      public boolean applyForAllMultiEditObjects()
      internal use only
      Returns:
      applyForAllMultiEditObjects

    • setApplyForAllMultiEditObjects

      public void setApplyForAllMultiEditObjects(boolean applyForAllMultiEditObjects)
      Parameters:
      applyForAllMultiEditObjects - false (default): One input question for every object during a multi edit. true: The client is instructed to ask for the input only once. You have to choose a general key for your input to work as expected, no object specific data within the key.