Class EventNotification


  • public class EventNotification
    extends Object
    Content of the EventNotification message. It conveys Information related to the event, and possible action (maintenance, message to display).
    • Constructor Detail

      • EventNotification

        public EventNotification()
    • Method Detail

      • timeStamp

        public EventNotification timeStamp​(OffsetDateTime timeStamp)
        Date and time of a transaction for the Sale System, the POI System or the Acquirer.
        Parameters:
        timeStamp - Date and time of a transaction for the Sale System, the POI System or the Acquirer.
        Returns:
        the current EventNotification instance, allowing for method chaining
      • getTimeStamp

        public OffsetDateTime getTimeStamp()
        Date and time of a transaction for the Sale System, the POI System or the Acquirer.
        Returns:
        timeStamp Date and time of a transaction for the Sale System, the POI System or the Acquirer.
      • setTimeStamp

        public void setTimeStamp​(OffsetDateTime timeStamp)
        Date and time of a transaction for the Sale System, the POI System or the Acquirer.
        Parameters:
        timeStamp - Date and time of a transaction for the Sale System, the POI System or the Acquirer.
      • eventToNotify

        public EventNotification eventToNotify​(EventToNotify eventToNotify)
        eventToNotify
        Parameters:
        eventToNotify -
        Returns:
        the current EventNotification instance, allowing for method chaining
      • getEventToNotify

        public EventToNotify getEventToNotify()
        Get eventToNotify
        Returns:
        eventToNotify
      • setEventToNotify

        public void setEventToNotify​(EventToNotify eventToNotify)
        eventToNotify
        Parameters:
        eventToNotify -
      • eventDetails

        public EventNotification eventDetails​(String eventDetails)
        Information about the event the POI notifies to the Sale System. If present, the Sale logs it for further examination.
        Parameters:
        eventDetails - Information about the event the POI notifies to the Sale System. If present, the Sale logs it for further examination.
        Returns:
        the current EventNotification instance, allowing for method chaining
      • getEventDetails

        public String getEventDetails()
        Information about the event the POI notifies to the Sale System. If present, the Sale logs it for further examination.
        Returns:
        eventDetails Information about the event the POI notifies to the Sale System. If present, the Sale logs it for further examination.
      • setEventDetails

        public void setEventDetails​(String eventDetails)
        Information about the event the POI notifies to the Sale System. If present, the Sale logs it for further examination.
        Parameters:
        eventDetails - Information about the event the POI notifies to the Sale System. If present, the Sale logs it for further examination.
      • rejectedMessage

        public EventNotification rejectedMessage​(byte[] rejectedMessage)
        Message request rejected by the receiver. Mandatory if EventToNotify is Reject, absent in other cases.
        Parameters:
        rejectedMessage - Message request rejected by the receiver. Mandatory if EventToNotify is Reject, absent in other cases.
        Returns:
        the current EventNotification instance, allowing for method chaining
      • getRejectedMessage

        public byte[] getRejectedMessage()
        Message request rejected by the receiver. Mandatory if EventToNotify is Reject, absent in other cases.
        Returns:
        rejectedMessage Message request rejected by the receiver. Mandatory if EventToNotify is Reject, absent in other cases.
      • setRejectedMessage

        public void setRejectedMessage​(byte[] rejectedMessage)
        Message request rejected by the receiver. Mandatory if EventToNotify is Reject, absent in other cases.
        Parameters:
        rejectedMessage - Message request rejected by the receiver. Mandatory if EventToNotify is Reject, absent in other cases.
      • maintenanceRequiredFlag

        public EventNotification maintenanceRequiredFlag​(Boolean maintenanceRequiredFlag)
        Indicates if the occurred event requires maintenance call or action.
        Parameters:
        maintenanceRequiredFlag - Indicates if the occurred event requires maintenance call or action.
        Returns:
        the current EventNotification instance, allowing for method chaining
      • getMaintenanceRequiredFlag

        public Boolean getMaintenanceRequiredFlag()
        Indicates if the occurred event requires maintenance call or action.
        Returns:
        maintenanceRequiredFlag Indicates if the occurred event requires maintenance call or action.
      • setMaintenanceRequiredFlag

        public void setMaintenanceRequiredFlag​(Boolean maintenanceRequiredFlag)
        Indicates if the occurred event requires maintenance call or action.
        Parameters:
        maintenanceRequiredFlag - Indicates if the occurred event requires maintenance call or action.
      • displayOutput

        public EventNotification displayOutput​(List<DisplayOutput> displayOutput)
        Information to display and the way to process the display. To display an event message.
        Parameters:
        displayOutput - Information to display and the way to process the display. To display an event message.
        Returns:
        the current EventNotification instance, allowing for method chaining
      • getDisplayOutput

        public List<DisplayOutput> getDisplayOutput()
        Information to display and the way to process the display. To display an event message.
        Returns:
        displayOutput Information to display and the way to process the display. To display an event message.
      • setDisplayOutput

        public void setDisplayOutput​(List<DisplayOutput> displayOutput)
        Information to display and the way to process the display. To display an event message.
        Parameters:
        displayOutput - Information to display and the way to process the display. To display an event message.
      • includeNullValues

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

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