Class Input


  • public class Input
    extends Object
    Input
    • Constructor Detail

      • Input

        public Input()
    • Method Detail

      • inputCommand

        public Input inputCommand​(InputCommand inputCommand)
        inputCommand
        Parameters:
        inputCommand -
        Returns:
        the current Input instance, allowing for method chaining
      • getInputCommand

        public InputCommand getInputCommand()
        Get inputCommand
        Returns:
        inputCommand
      • setInputCommand

        public void setInputCommand​(InputCommand inputCommand)
        inputCommand
        Parameters:
        inputCommand -
      • confirmedFlag

        public Input confirmedFlag​(Boolean confirmedFlag)
        Indicates te response of the user from the `GetConfirmation` input command.
        Parameters:
        confirmedFlag - Indicates te response of the user from the `GetConfirmation` input command.
        Returns:
        the current Input instance, allowing for method chaining
      • getConfirmedFlag

        public Boolean getConfirmedFlag()
        Indicates te response of the user from the `GetConfirmation` input command.
        Returns:
        confirmedFlag Indicates te response of the user from the `GetConfirmation` input command.
      • setConfirmedFlag

        public void setConfirmedFlag​(Boolean confirmedFlag)
        Indicates te response of the user from the `GetConfirmation` input command.
        Parameters:
        confirmedFlag - Indicates te response of the user from the `GetConfirmation` input command.
      • functionKey

        public Input functionKey​(Integer functionKey)
        The number of the function key which is typed by the Customer on the POI or the Cashier on the Sale Terminal.
        Parameters:
        functionKey - The number of the function key which is typed by the Customer on the POI or the Cashier on the Sale Terminal.
        Returns:
        the current Input instance, allowing for method chaining
      • getFunctionKey

        public Integer getFunctionKey()
        The number of the function key which is typed by the Customer on the POI or the Cashier on the Sale Terminal.
        Returns:
        functionKey The number of the function key which is typed by the Customer on the POI or the Cashier on the Sale Terminal.
      • setFunctionKey

        public void setFunctionKey​(Integer functionKey)
        The number of the function key which is typed by the Customer on the POI or the Cashier on the Sale Terminal.
        Parameters:
        functionKey - The number of the function key which is typed by the Customer on the POI or the Cashier on the Sale Terminal.
      • textInput

        public Input textInput​(String textInput)
        The text typed by the Customer on the POI or by the Cashier on the Sale Terminal.
        Parameters:
        textInput - The text typed by the Customer on the POI or by the Cashier on the Sale Terminal.
        Returns:
        the current Input instance, allowing for method chaining
      • getTextInput

        public String getTextInput()
        The text typed by the Customer on the POI or by the Cashier on the Sale Terminal.
        Returns:
        textInput The text typed by the Customer on the POI or by the Cashier on the Sale Terminal.
      • setTextInput

        public void setTextInput​(String textInput)
        The text typed by the Customer on the POI or by the Cashier on the Sale Terminal.
        Parameters:
        textInput - The text typed by the Customer on the POI or by the Cashier on the Sale Terminal.
      • digitInput

        public Input digitInput​(Integer digitInput)
        The digits typed by the Customer on the POI or by the Cashier on the Sale Terminal.
        Parameters:
        digitInput - The digits typed by the Customer on the POI or by the Cashier on the Sale Terminal.
        Returns:
        the current Input instance, allowing for method chaining
      • getDigitInput

        public Integer getDigitInput()
        The digits typed by the Customer on the POI or by the Cashier on the Sale Terminal.
        Returns:
        digitInput The digits typed by the Customer on the POI or by the Cashier on the Sale Terminal.
      • setDigitInput

        public void setDigitInput​(Integer digitInput)
        The digits typed by the Customer on the POI or by the Cashier on the Sale Terminal.
        Parameters:
        digitInput - The digits typed by the Customer on the POI or by the Cashier on the Sale Terminal.
      • password

        public Input password​(String password)
        The text password typed by the Customer on the POI or by the Cashier on the Sale Terminal.
        Parameters:
        password - The text password typed by the Customer on the POI or by the Cashier on the Sale Terminal.
        Returns:
        the current Input instance, allowing for method chaining
      • getPassword

        public String getPassword()
        The text password typed by the Customer on the POI or by the Cashier on the Sale Terminal.
        Returns:
        password The text password typed by the Customer on the POI or by the Cashier on the Sale Terminal.
      • setPassword

        public void setPassword​(String password)
        The text password typed by the Customer on the POI or by the Cashier on the Sale Terminal.
        Parameters:
        password - The text password typed by the Customer on the POI or by the Cashier on the Sale Terminal.
      • menuEntryNumber

        public Input menuEntryNumber​(List<Integer> menuEntryNumber)
        The index of the menu item (from 1 to n) which is selected by the Cashier on the Sale Terminal. The value -1 indicates that the immediate upper level of the menu is requested. The value 0 indicates that the root of the menu is requested.
        Parameters:
        menuEntryNumber - The index of the menu item (from 1 to n) which is selected by the Cashier on the Sale Terminal. The value -1 indicates that the immediate upper level of the menu is requested. The value 0 indicates that the root of the menu is requested.
        Returns:
        the current Input instance, allowing for method chaining
      • addMenuEntryNumberItem

        public Input addMenuEntryNumberItem​(Integer menuEntryNumberItem)
      • getMenuEntryNumber

        public List<Integer> getMenuEntryNumber()
        The index of the menu item (from 1 to n) which is selected by the Cashier on the Sale Terminal. The value -1 indicates that the immediate upper level of the menu is requested. The value 0 indicates that the root of the menu is requested.
        Returns:
        menuEntryNumber The index of the menu item (from 1 to n) which is selected by the Cashier on the Sale Terminal. The value -1 indicates that the immediate upper level of the menu is requested. The value 0 indicates that the root of the menu is requested.
      • setMenuEntryNumber

        public void setMenuEntryNumber​(List<Integer> menuEntryNumber)
        The index of the menu item (from 1 to n) which is selected by the Cashier on the Sale Terminal. The value -1 indicates that the immediate upper level of the menu is requested. The value 0 indicates that the root of the menu is requested.
        Parameters:
        menuEntryNumber - The index of the menu item (from 1 to n) which is selected by the Cashier on the Sale Terminal. The value -1 indicates that the immediate upper level of the menu is requested. The value 0 indicates that the root of the menu is requested.
      • includeNullValues

        public Input includeNullValues​(boolean includeNullValues)
        Configures whether null values are explicitly serialized in the JSON payload. Default is false.
      • isIncludeNullValues

        public boolean isIncludeNullValues()
        Returns whether null values are explicitly serialized in the JSON payload.
      • setIncludeNullValues

        public void setIncludeNullValues​(boolean includeNullValues)
        Sets whether null values should be explicitly serialized in the JSON payload. Default is false.
      • equals

        public boolean equals​(Object o)
        Return true if this Input object is equal to o.
        Overrides:
        equals in class Object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object
      • getExplicitNulls

        public Map<String,​Object> getExplicitNulls()
        Returns a map of properties to be merged into the JSON payload as explicit null values.
      • fromJson

        public static Input fromJson​(String jsonString)
                              throws com.fasterxml.jackson.core.JsonProcessingException
        Create an instance of Input given an JSON string
        Parameters:
        jsonString - JSON string
        Returns:
        An instance of Input
        Throws:
        com.fasterxml.jackson.core.JsonProcessingException - if the JSON string is invalid with respect to Input
      • toJson

        public String toJson()
                      throws com.fasterxml.jackson.core.JsonProcessingException
        Convert an instance of Input to an JSON string
        Returns:
        JSON string
        Throws:
        com.fasterxml.jackson.core.JsonProcessingException