Package com.helger.phase4.model.error

Interface IEbmsError

All Known Implementing Classes:
EbmsError, EEbmsError
public interface IEbmsError
Base interface for a single EBMS error
Author:
Philip Helger

  • Method Details

    • getErrorCode

      @NonNull String getErrorCode()
      Gets the value of the errorCode property.
      Returns:
      possible object is String

    • getSeverity

      @NonNull EEbmsErrorSeverity getSeverity()
      Gets the value of the severity property.
      Returns:
      possible object is String

    • getShortDescription

      @NonNull String getShortDescription()
      Gets the value of the shortDescription property.
      Returns:
      Short description. Never null.

    • getDescription

      @NonNull com.helger.text.display.IHasDisplayText getDescription()
      Gets the value of the description property.
      Returns:
      The multilingual description.
      Since:
      2.6.0

    • getCategory

      @NonNull EEbmsErrorCategory getCategory()
      Gets the value of the category property.
      Returns:
      possible object is EEbmsErrorCategory

    • errorBuilder

      default @NonNull Ebms3ErrorBuilder errorBuilder(@NonNull Locale aContentLocale)
      Create a new Ebms3ErrorBuilder with the information of this element. Sets description, category, errorCode, severity and shortDescription.
      Parameters:
      aContentLocale - Content locale to use. May not be null.
      Returns:
      Never null.
      Since:
      2.6.0