Package com.adyen.model.tapi

Class InputData

  • public class InputData
extends Object
    InputData

    • Constructor Detail

      • InputData

        public InputData()

    • Method Detail

      • device

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

      • getDevice

        public Device getDevice()
        Get device
        Returns:
        device

      • setDevice

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

      • infoQualify

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

      • getInfoQualify

        public InfoQualify getInfoQualify()
        Get infoQualify
        Returns:
        infoQualify

      • setInfoQualify

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

      • inputCommand

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

      • getInputCommand

        public InputCommand getInputCommand()
        Get inputCommand
        Returns:
        inputCommand

      • setInputCommand

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

      • notifyCardInputFlag

        public InputData notifyCardInputFlag​(Boolean notifyCardInputFlag)
        Request Notification of the card entered in the POI card reader.
        Parameters:
        notifyCardInputFlag - Request Notification of the card entered in the POI card reader.
        Returns:
        the current InputData instance, allowing for method chaining

      • getNotifyCardInputFlag

        public Boolean getNotifyCardInputFlag()
        Request Notification of the card entered in the POI card reader.
        Returns:
        notifyCardInputFlag Request Notification of the card entered in the POI card reader.

      • setNotifyCardInputFlag

        public void setNotifyCardInputFlag​(Boolean notifyCardInputFlag)
        Request Notification of the card entered in the POI card reader.
        Parameters:
        notifyCardInputFlag - Request Notification of the card entered in the POI card reader.

      • maxInputTime

        public InputData maxInputTime​(Integer maxInputTime)
        Maximum input time in seconds. Limits the time to answer to an Input request message.
        Parameters:
        maxInputTime - Maximum input time in seconds. Limits the time to answer to an Input request message.
        Returns:
        the current InputData instance, allowing for method chaining

      • getMaxInputTime

        public Integer getMaxInputTime()
        Maximum input time in seconds. Limits the time to answer to an Input request message.
        Returns:
        maxInputTime Maximum input time in seconds. Limits the time to answer to an Input request message.

      • setMaxInputTime

        public void setMaxInputTime​(Integer maxInputTime)
        Maximum input time in seconds. Limits the time to answer to an Input request message.
        Parameters:
        maxInputTime - Maximum input time in seconds. Limits the time to answer to an Input request message.

      • immediateResponseFlag

        public InputData immediateResponseFlag​(Boolean immediateResponseFlag)
        Indicates whether to request an Immediate response to the message without waiting for the completion of the command.
        Parameters:
        immediateResponseFlag - Indicates whether to request an Immediate response to the message without waiting for the completion of the command.
        Returns:
        the current InputData instance, allowing for method chaining

      • getImmediateResponseFlag

        public Boolean getImmediateResponseFlag()
        Indicates whether to request an Immediate response to the message without waiting for the completion of the command.
        Returns:
        immediateResponseFlag Indicates whether to request an Immediate response to the message without waiting for the completion of the command.

      • setImmediateResponseFlag

        public void setImmediateResponseFlag​(Boolean immediateResponseFlag)
        Indicates whether to request an Immediate response to the message without waiting for the completion of the command.
        Parameters:
        immediateResponseFlag - Indicates whether to request an Immediate response to the message without waiting for the completion of the command.

      • minLength

        public InputData minLength​(Integer minLength)
        Minimum length of an entered string, or minimum number of entries that can be selected in a menu.
        Parameters:
        minLength - Minimum length of an entered string, or minimum number of entries that can be selected in a menu.
        Returns:
        the current InputData instance, allowing for method chaining

      • getMinLength

        public Integer getMinLength()
        Minimum length of an entered string, or minimum number of entries that can be selected in a menu.
        Returns:
        minLength Minimum length of an entered string, or minimum number of entries that can be selected in a menu.

      • setMinLength

        public void setMinLength​(Integer minLength)
        Minimum length of an entered string, or minimum number of entries that can be selected in a menu.
        Parameters:
        minLength - Minimum length of an entered string, or minimum number of entries that can be selected in a menu.

      • maxLength

        public InputData maxLength​(Integer maxLength)
        Maximum length of an entered string, or maximum number of entries that can be selected in a menu.
        Parameters:
        maxLength - Maximum length of an entered string, or maximum number of entries that can be selected in a menu.
        Returns:
        the current InputData instance, allowing for method chaining

      • getMaxLength

        public Integer getMaxLength()
        Maximum length of an entered string, or maximum number of entries that can be selected in a menu.
        Returns:
        maxLength Maximum length of an entered string, or maximum number of entries that can be selected in a menu.

      • setMaxLength

        public void setMaxLength​(Integer maxLength)
        Maximum length of an entered string, or maximum number of entries that can be selected in a menu.
        Parameters:
        maxLength - Maximum length of an entered string, or maximum number of entries that can be selected in a menu.

      • maxDecimalLength

        public InputData maxDecimalLength​(Integer maxDecimalLength)
        Maximum input length of the decimal part (without decimal point).
        Parameters:
        maxDecimalLength - Maximum input length of the decimal part (without decimal point).
        Returns:
        the current InputData instance, allowing for method chaining

      • getMaxDecimalLength

        public Integer getMaxDecimalLength()
        Maximum input length of the decimal part (without decimal point).
        Returns:
        maxDecimalLength Maximum input length of the decimal part (without decimal point).

      • setMaxDecimalLength

        public void setMaxDecimalLength​(Integer maxDecimalLength)
        Maximum input length of the decimal part (without decimal point).
        Parameters:
        maxDecimalLength - Maximum input length of the decimal part (without decimal point).

      • waitUserValidationFlag

        public InputData waitUserValidationFlag​(Boolean waitUserValidationFlag)
        Indicates that the user must confirm the entered characters, when the maximum allowed length is reached. During the processing of an Input command `TextString`, `DigitString` or `DecimalString` with `MaxLength` or `MaxDecimalLength` present in the request.
        Parameters:
        waitUserValidationFlag - Indicates that the user must confirm the entered characters, when the maximum allowed length is reached. During the processing of an Input command `TextString`, `DigitString` or `DecimalString` with `MaxLength` or `MaxDecimalLength` present in the request.
        Returns:
        the current InputData instance, allowing for method chaining

      • getWaitUserValidationFlag

        public Boolean getWaitUserValidationFlag()
        Indicates that the user must confirm the entered characters, when the maximum allowed length is reached. During the processing of an Input command `TextString`, `DigitString` or `DecimalString` with `MaxLength` or `MaxDecimalLength` present in the request.
        Returns:
        waitUserValidationFlag Indicates that the user must confirm the entered characters, when the maximum allowed length is reached. During the processing of an Input command `TextString`, `DigitString` or `DecimalString` with `MaxLength` or `MaxDecimalLength` present in the request.

      • setWaitUserValidationFlag

        public void setWaitUserValidationFlag​(Boolean waitUserValidationFlag)
        Indicates that the user must confirm the entered characters, when the maximum allowed length is reached. During the processing of an Input command `TextString`, `DigitString` or `DecimalString` with `MaxLength` or `MaxDecimalLength` present in the request.
        Parameters:
        waitUserValidationFlag - Indicates that the user must confirm the entered characters, when the maximum allowed length is reached. During the processing of an Input command `TextString`, `DigitString` or `DecimalString` with `MaxLength` or `MaxDecimalLength` present in the request.

      • defaultInputString

        public InputData defaultInputString​(String defaultInputString)
        Default string value for an input command. On the `TextString`, `DigitString` and `DecimalString` input commands: default string displayed on the input field before entering the string. In `GetConfirmation` input command: **Y** for yes, **N** for no.
        Parameters:
        defaultInputString - Default string value for an input command. On the `TextString`, `DigitString` and `DecimalString` input commands: default string displayed on the input field before entering the string. In `GetConfirmation` input command: **Y** for yes, **N** for no.
        Returns:
        the current InputData instance, allowing for method chaining

      • getDefaultInputString

        public String getDefaultInputString()
        Default string value for an input command. On the `TextString`, `DigitString` and `DecimalString` input commands: default string displayed on the input field before entering the string. In `GetConfirmation` input command: **Y** for yes, **N** for no.
        Returns:
        defaultInputString Default string value for an input command. On the `TextString`, `DigitString` and `DecimalString` input commands: default string displayed on the input field before entering the string. In `GetConfirmation` input command: **Y** for yes, **N** for no.

      • setDefaultInputString

        public void setDefaultInputString​(String defaultInputString)
        Default string value for an input command. On the `TextString`, `DigitString` and `DecimalString` input commands: default string displayed on the input field before entering the string. In `GetConfirmation` input command: **Y** for yes, **N** for no.
        Parameters:
        defaultInputString - Default string value for an input command. On the `TextString`, `DigitString` and `DecimalString` input commands: default string displayed on the input field before entering the string. In `GetConfirmation` input command: **Y** for yes, **N** for no.

      • defaultLayoutString

        public InputData defaultLayoutString​(String defaultLayoutString)
        defaultLayoutString
        Parameters:
        defaultLayoutString -
        Returns:
        the current InputData instance, allowing for method chaining

      • getDefaultLayoutString

        public String getDefaultLayoutString()
        Get defaultLayoutString
        Returns:
        defaultLayoutString

      • setDefaultLayoutString

        public void setDefaultLayoutString​(String defaultLayoutString)
        defaultLayoutString
        Parameters:
        defaultLayoutString -

      • stringMask

        public InputData stringMask​(String stringMask)
        String mask to get information requiring a specific format. For the processing of an Input command `TextString`, `DigitString` or `DecimalString`. Some information as date or plate number required to be entered with a certain format.
        Parameters:
        stringMask - String mask to get information requiring a specific format. For the processing of an Input command `TextString`, `DigitString` or `DecimalString`. Some information as date or plate number required to be entered with a certain format.
        Returns:
        the current InputData instance, allowing for method chaining

      • getStringMask

        public String getStringMask()
        String mask to get information requiring a specific format. For the processing of an Input command `TextString`, `DigitString` or `DecimalString`. Some information as date or plate number required to be entered with a certain format.
        Returns:
        stringMask String mask to get information requiring a specific format. For the processing of an Input command `TextString`, `DigitString` or `DecimalString`. Some information as date or plate number required to be entered with a certain format.

      • setStringMask

        public void setStringMask​(String stringMask)
        String mask to get information requiring a specific format. For the processing of an Input command `TextString`, `DigitString` or `DecimalString`. Some information as date or plate number required to be entered with a certain format.
        Parameters:
        stringMask - String mask to get information requiring a specific format. For the processing of an Input command `TextString`, `DigitString` or `DecimalString`. Some information as date or plate number required to be entered with a certain format.

      • fromRightToLeftFlag

        public InputData fromRightToLeftFlag​(Boolean fromRightToLeftFlag)
        Indicates if the entered character has to be displayed from the right to the left of the display field.
        Parameters:
        fromRightToLeftFlag - Indicates if the entered character has to be displayed from the right to the left of the display field.
        Returns:
        the current InputData instance, allowing for method chaining

      • getFromRightToLeftFlag

        public Boolean getFromRightToLeftFlag()
        Indicates if the entered character has to be displayed from the right to the left of the display field.
        Returns:
        fromRightToLeftFlag Indicates if the entered character has to be displayed from the right to the left of the display field.

      • setFromRightToLeftFlag

        public void setFromRightToLeftFlag​(Boolean fromRightToLeftFlag)
        Indicates if the entered character has to be displayed from the right to the left of the display field.
        Parameters:
        fromRightToLeftFlag - Indicates if the entered character has to be displayed from the right to the left of the display field.

      • maskCharactersFlag

        public InputData maskCharactersFlag​(Boolean maskCharactersFlag)
        Indicates to mask the characters entered by the user (i.e. replacing in the display of the input, the entered character by a standard character as *).
        Parameters:
        maskCharactersFlag - Indicates to mask the characters entered by the user (i.e. replacing in the display of the input, the entered character by a standard character as *).
        Returns:
        the current InputData instance, allowing for method chaining

      • getMaskCharactersFlag

        public Boolean getMaskCharactersFlag()
        Indicates to mask the characters entered by the user (i.e. replacing in the display of the input, the entered character by a standard character as *).
        Returns:
        maskCharactersFlag Indicates to mask the characters entered by the user (i.e. replacing in the display of the input, the entered character by a standard character as *).

      • setMaskCharactersFlag

        public void setMaskCharactersFlag​(Boolean maskCharactersFlag)
        Indicates to mask the characters entered by the user (i.e. replacing in the display of the input, the entered character by a standard character as *).
        Parameters:
        maskCharactersFlag - Indicates to mask the characters entered by the user (i.e. replacing in the display of the input, the entered character by a standard character as *).

      • beepKeyFlag

        public InputData beepKeyFlag​(Boolean beepKeyFlag)
        Indicates, when the user press a key, if a beep has to be generated (value True).
        Parameters:
        beepKeyFlag - Indicates, when the user press a key, if a beep has to be generated (value True).
        Returns:
        the current InputData instance, allowing for method chaining

      • getBeepKeyFlag

        public Boolean getBeepKeyFlag()
        Indicates, when the user press a key, if a beep has to be generated (value True).
        Returns:
        beepKeyFlag Indicates, when the user press a key, if a beep has to be generated (value True).

      • setBeepKeyFlag

        public void setBeepKeyFlag​(Boolean beepKeyFlag)
        Indicates, when the user press a key, if a beep has to be generated (value True).
        Parameters:
        beepKeyFlag - Indicates, when the user press a key, if a beep has to be generated (value True).

      • globalCorrectionFlag

        public InputData globalCorrectionFlag​(Boolean globalCorrectionFlag)
        Indicates, when the user presses the Correct function key in an input entry, if all the entered characters are removed (value True) or only the last entered character if any (value False).
        Parameters:
        globalCorrectionFlag - Indicates, when the user presses the Correct function key in an input entry, if all the entered characters are removed (value True) or only the last entered character if any (value False).
        Returns:
        the current InputData instance, allowing for method chaining

      • getGlobalCorrectionFlag

        public Boolean getGlobalCorrectionFlag()
        Indicates, when the user presses the Correct function key in an input entry, if all the entered characters are removed (value True) or only the last entered character if any (value False).
        Returns:
        globalCorrectionFlag Indicates, when the user presses the Correct function key in an input entry, if all the entered characters are removed (value True) or only the last entered character if any (value False).

      • setGlobalCorrectionFlag

        public void setGlobalCorrectionFlag​(Boolean globalCorrectionFlag)
        Indicates, when the user presses the Correct function key in an input entry, if all the entered characters are removed (value True) or only the last entered character if any (value False).
        Parameters:
        globalCorrectionFlag - Indicates, when the user presses the Correct function key in an input entry, if all the entered characters are removed (value True) or only the last entered character if any (value False).

      • disableCancelFlag

        public InputData disableCancelFlag​(Boolean disableCancelFlag)
        Indicates if the Cancel function key has to be deactivated (value True).
        Parameters:
        disableCancelFlag - Indicates if the Cancel function key has to be deactivated (value True).
        Returns:
        the current InputData instance, allowing for method chaining

      • getDisableCancelFlag

        public Boolean getDisableCancelFlag()
        Indicates if the Cancel function key has to be deactivated (value True).
        Returns:
        disableCancelFlag Indicates if the Cancel function key has to be deactivated (value True).

      • setDisableCancelFlag

        public void setDisableCancelFlag​(Boolean disableCancelFlag)
        Indicates if the Cancel function key has to be deactivated (value True).
        Parameters:
        disableCancelFlag - Indicates if the Cancel function key has to be deactivated (value True).

      • disableCorrectFlag

        public InputData disableCorrectFlag​(Boolean disableCorrectFlag)
        Indicates if the Correct function key has to be deactivated (value True). During the processing of an Input command `GetConfirmation`, `SiteManager`, or `GetMenuEntry`.
        Parameters:
        disableCorrectFlag - Indicates if the Correct function key has to be deactivated (value True). During the processing of an Input command `GetConfirmation`, `SiteManager`, or `GetMenuEntry`.
        Returns:
        the current InputData instance, allowing for method chaining

      • getDisableCorrectFlag

        public Boolean getDisableCorrectFlag()
        Indicates if the Correct function key has to be deactivated (value True). During the processing of an Input command `GetConfirmation`, `SiteManager`, or `GetMenuEntry`.
        Returns:
        disableCorrectFlag Indicates if the Correct function key has to be deactivated (value True). During the processing of an Input command `GetConfirmation`, `SiteManager`, or `GetMenuEntry`.

      • setDisableCorrectFlag

        public void setDisableCorrectFlag​(Boolean disableCorrectFlag)
        Indicates if the Correct function key has to be deactivated (value True). During the processing of an Input command `GetConfirmation`, `SiteManager`, or `GetMenuEntry`.
        Parameters:
        disableCorrectFlag - Indicates if the Correct function key has to be deactivated (value True). During the processing of an Input command `GetConfirmation`, `SiteManager`, or `GetMenuEntry`.

      • disableValidFlag

        public InputData disableValidFlag​(Boolean disableValidFlag)
        Indicates if the Valid function key has to be deactivated (value True). During the processing of an Input command `GetConfirmation`, `SiteManager`, or `GetMenuEntry`.
        Parameters:
        disableValidFlag - Indicates if the Valid function key has to be deactivated (value True). During the processing of an Input command `GetConfirmation`, `SiteManager`, or `GetMenuEntry`.
        Returns:
        the current InputData instance, allowing for method chaining

      • getDisableValidFlag

        public Boolean getDisableValidFlag()
        Indicates if the Valid function key has to be deactivated (value True). During the processing of an Input command `GetConfirmation`, `SiteManager`, or `GetMenuEntry`.
        Returns:
        disableValidFlag Indicates if the Valid function key has to be deactivated (value True). During the processing of an Input command `GetConfirmation`, `SiteManager`, or `GetMenuEntry`.

      • setDisableValidFlag

        public void setDisableValidFlag​(Boolean disableValidFlag)
        Indicates if the Valid function key has to be deactivated (value True). During the processing of an Input command `GetConfirmation`, `SiteManager`, or `GetMenuEntry`.
        Parameters:
        disableValidFlag - Indicates if the Valid function key has to be deactivated (value True). During the processing of an Input command `GetConfirmation`, `SiteManager`, or `GetMenuEntry`.

      • menuBackFlag

        public InputData menuBackFlag​(Boolean menuBackFlag)
        If it has the value True, it indicates that the Back function key (respectively Home function key) may be used to go back to the immediate upper level of the menu. If it has the value False, it indicates that the current menu level has no parent menu.
        Parameters:
        menuBackFlag - If it has the value True, it indicates that the Back function key (respectively Home function key) may be used to go back to the immediate upper level of the menu. If it has the value False, it indicates that the current menu level has no parent menu.
        Returns:
        the current InputData instance, allowing for method chaining

      • getMenuBackFlag

        public Boolean getMenuBackFlag()
        If it has the value True, it indicates that the Back function key (respectively Home function key) may be used to go back to the immediate upper level of the menu. If it has the value False, it indicates that the current menu level has no parent menu.
        Returns:
        menuBackFlag If it has the value True, it indicates that the Back function key (respectively Home function key) may be used to go back to the immediate upper level of the menu. If it has the value False, it indicates that the current menu level has no parent menu.

      • setMenuBackFlag

        public void setMenuBackFlag​(Boolean menuBackFlag)
        If it has the value True, it indicates that the Back function key (respectively Home function key) may be used to go back to the immediate upper level of the menu. If it has the value False, it indicates that the current menu level has no parent menu.
        Parameters:
        menuBackFlag - If it has the value True, it indicates that the Back function key (respectively Home function key) may be used to go back to the immediate upper level of the menu. If it has the value False, it indicates that the current menu level has no parent menu.

      • includeNullValues

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

      • toJson

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