Package com.onlinepayments.domain

Class PaymentProductFieldDisplayHints

java.lang.Object
com.onlinepayments.domain.PaymentProductFieldDisplayHints
public class PaymentProductFieldDisplayHints extends Object

  • Constructor Details

    • PaymentProductFieldDisplayHints

      public PaymentProductFieldDisplayHints()

  • Method Details

    • getAlwaysShow

      public Boolean getAlwaysShow()
      • true - Indicates that this field is advised to be captured to increase the success rates even-though it isn't marked as required. Please note that making the field required could hurt the success rates negatively. This boolean only indicates our advise to always show this field to the customer.
      • false - Indicates that this field is not to be shown unless it is a required field.

    • setAlwaysShow

      public void setAlwaysShow(Boolean value)
      • true - Indicates that this field is advised to be captured to increase the success rates even-though it isn't marked as required. Please note that making the field required could hurt the success rates negatively. This boolean only indicates our advise to always show this field to the customer.
      • false - Indicates that this field is not to be shown unless it is a required field.

    • withAlwaysShow

      public PaymentProductFieldDisplayHints withAlwaysShow(Boolean value)
      • true - Indicates that this field is advised to be captured to increase the success rates even-though it isn't marked as required. Please note that making the field required could hurt the success rates negatively. This boolean only indicates our advise to always show this field to the customer.
      • false - Indicates that this field is not to be shown unless it is a required field.

    • getDisplayOrder

      public Integer getDisplayOrder()
      The order in which the fields should be shown (ascending)

    • setDisplayOrder

      public void setDisplayOrder(Integer value)
      The order in which the fields should be shown (ascending)

    • withDisplayOrder

      public PaymentProductFieldDisplayHints withDisplayOrder(Integer value)
      The order in which the fields should be shown (ascending)

    • getFormElement

      public PaymentProductFieldFormElement getFormElement()
      Object detailing the type of form element that should be used to present the field

    • setFormElement

      public void setFormElement(PaymentProductFieldFormElement value)
      Object detailing the type of form element that should be used to present the field

    • withFormElement

      public PaymentProductFieldDisplayHints withFormElement(PaymentProductFieldFormElement value)
      Object detailing the type of form element that should be used to present the field

    • getLabel

      public String getLabel()
      Label/Name of the field to be used in the user interface

    • setLabel

      public void setLabel(String value)
      Label/Name of the field to be used in the user interface

    • withLabel

      public PaymentProductFieldDisplayHints withLabel(String value)
      Label/Name of the field to be used in the user interface

    • getLink

      @Deprecated public String getLink()
      Deprecated.
      Deprecated
      Deprecated: This field is not used by any payment product Link that should be used to replace the '{link}' variable in the label.

    • setLink

      @Deprecated public void setLink(String value)
      Deprecated.
      Deprecated
      Deprecated: This field is not used by any payment product Link that should be used to replace the '{link}' variable in the label.

    • withLink

      @Deprecated public PaymentProductFieldDisplayHints withLink(String value)
      Deprecated.
      Deprecated
      Deprecated: This field is not used by any payment product Link that should be used to replace the '{link}' variable in the label.

    • getMask

      public String getMask()
      A mask that can be used in the input field. You can use it to inject additional characters to provide a better user experience and to restrict the accepted character set (illegal characters will be ignored during typing).
      • is used for wildcards (and also chars) 9 is used for numbers Everything outside {{ and }} is used as-is.

    • setMask

      public void setMask(String value)
      A mask that can be used in the input field. You can use it to inject additional characters to provide a better user experience and to restrict the accepted character set (illegal characters will be ignored during typing).
      • is used for wildcards (and also chars) 9 is used for numbers Everything outside {{ and }} is used as-is.

    • withMask

      public PaymentProductFieldDisplayHints withMask(String value)
      A mask that can be used in the input field. You can use it to inject additional characters to provide a better user experience and to restrict the accepted character set (illegal characters will be ignored during typing).
      • is used for wildcards (and also chars) 9 is used for numbers Everything outside {{ and }} is used as-is.

    • getObfuscate

      public Boolean getObfuscate()
      • true - The data in this field should be obfuscated as it is entered, just like a password field
      • false - The data in this field does not need to be obfuscated

    • setObfuscate

      public void setObfuscate(Boolean value)
      • true - The data in this field should be obfuscated as it is entered, just like a password field
      • false - The data in this field does not need to be obfuscated

    • withObfuscate

      public PaymentProductFieldDisplayHints withObfuscate(Boolean value)
      • true - The data in this field should be obfuscated as it is entered, just like a password field
      • false - The data in this field does not need to be obfuscated

    • getPlaceholderLabel

      public String getPlaceholderLabel()
      A placeholder value for the form element

    • setPlaceholderLabel

      public void setPlaceholderLabel(String value)
      A placeholder value for the form element

    • withPlaceholderLabel

      public PaymentProductFieldDisplayHints withPlaceholderLabel(String value)
      A placeholder value for the form element

    • getPreferredInputType

      public String getPreferredInputType()
      The type of keyboard that can best be used to fill out the value of this field. Possible values are:
      • PhoneNumberKeyboard - Keyboard that is normally used to enter phone numbers
      • StringKeyboard - Keyboard that is used to enter strings
      • IntegerKeyboard - Keyboard that is used to enter only numerical values
      • EmailAddressKeyboard - Keyboard that allows easier entry of email addresses

    • setPreferredInputType

      public void setPreferredInputType(String value)
      The type of keyboard that can best be used to fill out the value of this field. Possible values are:
      • PhoneNumberKeyboard - Keyboard that is normally used to enter phone numbers
      • StringKeyboard - Keyboard that is used to enter strings
      • IntegerKeyboard - Keyboard that is used to enter only numerical values
      • EmailAddressKeyboard - Keyboard that allows easier entry of email addresses

    • withPreferredInputType

      public PaymentProductFieldDisplayHints withPreferredInputType(String value)
      The type of keyboard that can best be used to fill out the value of this field. Possible values are:
      • PhoneNumberKeyboard - Keyboard that is normally used to enter phone numbers
      • StringKeyboard - Keyboard that is used to enter strings
      • IntegerKeyboard - Keyboard that is used to enter only numerical values
      • EmailAddressKeyboard - Keyboard that allows easier entry of email addresses

    • getTooltip

      public PaymentProductFieldTooltip getTooltip()
      Object that contains an optional tooltip to assist the customer

    • setTooltip

      public void setTooltip(PaymentProductFieldTooltip value)
      Object that contains an optional tooltip to assist the customer

    • withTooltip

      public PaymentProductFieldDisplayHints withTooltip(PaymentProductFieldTooltip value)
      Object that contains an optional tooltip to assist the customer