Class MenuEntry


  • public class MenuEntry
    extends Object
    An entry of the menu to present to the Cashier. It conveys message text and parameters of the menu entry. This output data could be only provided for an input command, in order to choose an entry of the menu.
    • Constructor Detail

      • MenuEntry

        public MenuEntry()
    • Method Detail

      • menuEntryTag

        public MenuEntry menuEntryTag​(MenuEntryTag menuEntryTag)
        menuEntryTag
        Parameters:
        menuEntryTag -
        Returns:
        the current MenuEntry instance, allowing for method chaining
      • getMenuEntryTag

        public MenuEntryTag getMenuEntryTag()
        Get menuEntryTag
        Returns:
        menuEntryTag
      • setMenuEntryTag

        public void setMenuEntryTag​(MenuEntryTag menuEntryTag)
        menuEntryTag
        Parameters:
        menuEntryTag -
      • defaultSelectedFlag

        public MenuEntry defaultSelectedFlag​(Boolean defaultSelectedFlag)
        Selection of a menu entry to be displayed. In Input request message, it allows selection of one or several menu entries before any user action.
        Parameters:
        defaultSelectedFlag - Selection of a menu entry to be displayed. In Input request message, it allows selection of one or several menu entries before any user action.
        Returns:
        the current MenuEntry instance, allowing for method chaining
      • getDefaultSelectedFlag

        public Boolean getDefaultSelectedFlag()
        Selection of a menu entry to be displayed. In Input request message, it allows selection of one or several menu entries before any user action.
        Returns:
        defaultSelectedFlag Selection of a menu entry to be displayed. In Input request message, it allows selection of one or several menu entries before any user action.
      • setDefaultSelectedFlag

        public void setDefaultSelectedFlag​(Boolean defaultSelectedFlag)
        Selection of a menu entry to be displayed. In Input request message, it allows selection of one or several menu entries before any user action.
        Parameters:
        defaultSelectedFlag - Selection of a menu entry to be displayed. In Input request message, it allows selection of one or several menu entries before any user action.
      • outputFormat

        public MenuEntry outputFormat​(OutputFormat outputFormat)
        outputFormat
        Parameters:
        outputFormat -
        Returns:
        the current MenuEntry instance, allowing for method chaining
      • getOutputFormat

        public OutputFormat getOutputFormat()
        Get outputFormat
        Returns:
        outputFormat
      • setOutputFormat

        public void setOutputFormat​(OutputFormat outputFormat)
        outputFormat
        Parameters:
        outputFormat -
      • predefinedContent

        public MenuEntry predefinedContent​(PredefinedContent predefinedContent)
        predefinedContent
        Parameters:
        predefinedContent -
        Returns:
        the current MenuEntry instance, allowing for method chaining
      • getPredefinedContent

        public PredefinedContent getPredefinedContent()
        Get predefinedContent
        Returns:
        predefinedContent
      • setPredefinedContent

        public void setPredefinedContent​(PredefinedContent predefinedContent)
        predefinedContent
        Parameters:
        predefinedContent -
      • outputText

        public MenuEntry outputText​(List<OutputText> outputText)
        Content of text message to display or print. It conveys Information related to the content of the text message and its format. All the data elements related to the format of the text to display or print are parameters valid for the whole Text content.
        Parameters:
        outputText - Content of text message to display or print. It conveys Information related to the content of the text message and its format. All the data elements related to the format of the text to display or print are parameters valid for the whole Text content.
        Returns:
        the current MenuEntry instance, allowing for method chaining
      • getOutputText

        public List<OutputText> getOutputText()
        Content of text message to display or print. It conveys Information related to the content of the text message and its format. All the data elements related to the format of the text to display or print are parameters valid for the whole Text content.
        Returns:
        outputText Content of text message to display or print. It conveys Information related to the content of the text message and its format. All the data elements related to the format of the text to display or print are parameters valid for the whole Text content.
      • setOutputText

        public void setOutputText​(List<OutputText> outputText)
        Content of text message to display or print. It conveys Information related to the content of the text message and its format. All the data elements related to the format of the text to display or print are parameters valid for the whole Text content.
        Parameters:
        outputText - Content of text message to display or print. It conveys Information related to the content of the text message and its format. All the data elements related to the format of the text to display or print are parameters valid for the whole Text content.
      • outputXHTML

        public MenuEntry outputXHTML​(byte[] outputXHTML)
        XHTML document body containing the message to display or print.
        Parameters:
        outputXHTML - XHTML document body containing the message to display or print.
        Returns:
        the current MenuEntry instance, allowing for method chaining
      • getOutputXHTML

        public byte[] getOutputXHTML()
        XHTML document body containing the message to display or print.
        Returns:
        outputXHTML XHTML document body containing the message to display or print.
      • setOutputXHTML

        public void setOutputXHTML​(byte[] outputXHTML)
        XHTML document body containing the message to display or print.
        Parameters:
        outputXHTML - XHTML document body containing the message to display or print.
      • includeNullValues

        public MenuEntry 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 MenuEntry 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 MenuEntry fromJson​(String jsonString)
                                  throws com.fasterxml.jackson.core.JsonProcessingException
        Create an instance of MenuEntry given an JSON string
        Parameters:
        jsonString - JSON string
        Returns:
        An instance of MenuEntry
        Throws:
        com.fasterxml.jackson.core.JsonProcessingException - if the JSON string is invalid with respect to MenuEntry
      • toJson

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