Class DisplayOutput


  • public class DisplayOutput
    extends Object
    Information to display and how to process it. Contains a complete display operation for a Display or an Input Device type. For the Input Devices, Diagnosis and `EnableService`, `ResponseRequiredFlag`, and `MinimumDisplayTime` shall be absent.
    • Constructor Detail

      • DisplayOutput

        public DisplayOutput()
    • Method Detail

      • responseRequiredFlag

        public DisplayOutput responseRequiredFlag​(Boolean responseRequiredFlag)
        Indicates if the message response is required.
        Parameters:
        responseRequiredFlag - Indicates if the message response is required.
        Returns:
        the current DisplayOutput instance, allowing for method chaining
      • getResponseRequiredFlag

        public Boolean getResponseRequiredFlag()
        Indicates if the message response is required.
        Returns:
        responseRequiredFlag Indicates if the message response is required.
      • setResponseRequiredFlag

        public void setResponseRequiredFlag​(Boolean responseRequiredFlag)
        Indicates if the message response is required.
        Parameters:
        responseRequiredFlag - Indicates if the message response is required.
      • minimumDisplayTime

        public DisplayOutput minimumDisplayTime​(Integer minimumDisplayTime)
        Number of seconds the message has to be displayed.
        Parameters:
        minimumDisplayTime - Number of seconds the message has to be displayed.
        Returns:
        the current DisplayOutput instance, allowing for method chaining
      • getMinimumDisplayTime

        public Integer getMinimumDisplayTime()
        Number of seconds the message has to be displayed. minimum: 0 maximum: 999
        Returns:
        minimumDisplayTime Number of seconds the message has to be displayed.
      • setMinimumDisplayTime

        public void setMinimumDisplayTime​(Integer minimumDisplayTime)
        Number of seconds the message has to be displayed.
        Parameters:
        minimumDisplayTime - Number of seconds the message has to be displayed.
      • device

        public DisplayOutput device​(Device device)
        device
        Parameters:
        device -
        Returns:
        the current DisplayOutput instance, allowing for method chaining
      • getDevice

        public Device getDevice()
        Get device
        Returns:
        device
      • setDevice

        public void setDevice​(Device device)
        device
        Parameters:
        device -
      • infoQualify

        public DisplayOutput infoQualify​(InfoQualify infoQualify)
        infoQualify
        Parameters:
        infoQualify -
        Returns:
        the current DisplayOutput instance, allowing for method chaining
      • getInfoQualify

        public InfoQualify getInfoQualify()
        Get infoQualify
        Returns:
        infoQualify
      • setInfoQualify

        public void setInfoQualify​(InfoQualify infoQualify)
        infoQualify
        Parameters:
        infoQualify -
      • outputContent

        public DisplayOutput outputContent​(OutputContent outputContent)
        outputContent
        Parameters:
        outputContent -
        Returns:
        the current DisplayOutput instance, allowing for method chaining
      • getOutputContent

        public OutputContent getOutputContent()
        Get outputContent
        Returns:
        outputContent
      • setOutputContent

        public void setOutputContent​(OutputContent outputContent)
        outputContent
        Parameters:
        outputContent -
      • menuEntry

        public DisplayOutput menuEntry​(List<MenuEntry> menuEntry)
        An entry of the menu to present to the Cashier. It conveys the message text and parameters of the menu entry. This output data could be only provided for an input command, in order to choose an entryof the menu.
        Parameters:
        menuEntry - An entry of the menu to present to the Cashier. It conveys the message text and parameters of the menu entry. This output data could be only provided for an input command, in order to choose an entryof the menu.
        Returns:
        the current DisplayOutput instance, allowing for method chaining
      • getMenuEntry

        public List<MenuEntry> getMenuEntry()
        An entry of the menu to present to the Cashier. It conveys the message text and parameters of the menu entry. This output data could be only provided for an input command, in order to choose an entryof the menu.
        Returns:
        menuEntry An entry of the menu to present to the Cashier. It conveys the message text and parameters of the menu entry. This output data could be only provided for an input command, in order to choose an entryof the menu.
      • setMenuEntry

        public void setMenuEntry​(List<MenuEntry> menuEntry)
        An entry of the menu to present to the Cashier. It conveys the message text and parameters of the menu entry. This output data could be only provided for an input command, in order to choose an entryof the menu.
        Parameters:
        menuEntry - An entry of the menu to present to the Cashier. It conveys the message text and parameters of the menu entry. This output data could be only provided for an input command, in order to choose an entryof the menu.
      • outputSignature

        public DisplayOutput outputSignature​(byte[] outputSignature)
        Vendor-specific signature of the text message to display or print. If protection has to be provided to the vendor on the text to display or print.
        Parameters:
        outputSignature - Vendor-specific signature of the text message to display or print. If protection has to be provided to the vendor on the text to display or print.
        Returns:
        the current DisplayOutput instance, allowing for method chaining
      • getOutputSignature

        public byte[] getOutputSignature()
        Vendor-specific signature of the text message to display or print. If protection has to be provided to the vendor on the text to display or print.
        Returns:
        outputSignature Vendor-specific signature of the text message to display or print. If protection has to be provided to the vendor on the text to display or print.
      • setOutputSignature

        public void setOutputSignature​(byte[] outputSignature)
        Vendor-specific signature of the text message to display or print. If protection has to be provided to the vendor on the text to display or print.
        Parameters:
        outputSignature - Vendor-specific signature of the text message to display or print. If protection has to be provided to the vendor on the text to display or print.
      • includeNullValues

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

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