Package net.codecrete.qrbill.generator

Class ValidationMessage

  • All Implemented Interfaces:
    java.io.Serializable
    public class ValidationMessage
extends java.lang.Object
implements java.io.Serializable
    QR bill validation message.
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  ValidationMessage.Type
      Type of validation message

    • Constructor Summary

      Constructors 
      Constructor Description
      ValidationMessage()
      Constructs a new validation message.
      ValidationMessage​(ValidationMessage.Type type, java.lang.String field, java.lang.String messageKey)
      Constructs a new validation message with the given values.
      ValidationMessage​(ValidationMessage.Type type, java.lang.String field, java.lang.String messageKey, java.lang.String[] messageParameters)
      Constructs a new validation message with the given values.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getField()
      Gets the name of the affected field.
      java.lang.String getMessageKey()
      Gets the language neutral key of the message.
      java.lang.String[] getMessageParameters()
      Gets additional message parameters (text) that are inserted into the localized message.
      ValidationMessage.Type getType()
      Gets the type of message
      void setField​(java.lang.String field)
      Sets the name of the affected field.
      void setMessageKey​(java.lang.String messageKey)
      Sets the language neutral key of the message.
      void setMessageParameters​(java.lang.String[] messageParameters)
      Sets additional message parameters (text) that are inserted into the localized message.
      void setType​(ValidationMessage.Type type)
      Sets the type of message

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • ValidationMessage

        public ValidationMessage()
        Constructs a new validation message.

      • ValidationMessage

        public ValidationMessage​(ValidationMessage.Type type,
                         java.lang.String field,
                         java.lang.String messageKey)
        Constructs a new validation message with the given values.
        Parameters:
        type - the message type
        field - the affect field
        messageKey - the language-neutral key of the message

      • ValidationMessage

        public ValidationMessage​(ValidationMessage.Type type,
                         java.lang.String field,
                         java.lang.String messageKey,
                         java.lang.String[] messageParameters)
        Constructs a new validation message with the given values.
        Parameters:
        type - the message type
        field - the affect field
        messageKey - the language-neutral key of the message
        messageParameters - variable text parts that will be inserted into the localized message

    • Method Detail

      • setType

        public void setType​(ValidationMessage.Type type)
        Sets the type of message
        Parameters:
        type - message type

      • getField

        public java.lang.String getField()
        Gets the name of the affected field.

        All field names are available as constants in Bill. Examples are: "account", "creditor.street"

        Returns:
        the field name

      • setField

        public void setField​(java.lang.String field)
        Sets the name of the affected field.

        All field names are available as constants in Bill. Examples are: "account", "creditor.street"

        Parameters:
        field - the field name

      • getMessageKey

        public java.lang.String getMessageKey()
        Gets the language neutral key of the message.
        Returns:
        the message key

      • setMessageKey

        public void setMessageKey​(java.lang.String messageKey)
        Sets the language neutral key of the message.
        Parameters:
        messageKey - the message key

      • getMessageParameters

        public java.lang.String[] getMessageParameters()
        Gets additional message parameters (text) that are inserted into the localized message.
        Returns:
        the additional message parameters

      • setMessageParameters

        public void setMessageParameters​(java.lang.String[] messageParameters)
        Sets additional message parameters (text) that are inserted into the localized message.
        Parameters:
        messageParameters - the additional message parameters