com.helger.phase4.error

Interface IEbmsError

All Superinterfaces:

Serializable

All Known Implementing Classes:

EEbmsError

public interface IEbmsError
extends Serializable

Base interface for a single EBMS error

Author:

Philip Helger

Method Summary

Modifier and Type	Method and Description
default Ebms3Error	getAsEbms3Error(Locale aContentLocale, String sRefToMessageInError)
default Ebms3Error	getAsEbms3Error(Locale aContentLocale, String sRefToMessageInError, String sErrorDescription)
default Ebms3Error	getAsEbms3Error(Locale aContentLocale, String sRefToMessageInError, String sOrigin, Ebms3Description aEbmsDescription)
default Ebms3Error	getAsEbms3Error(Locale aContentLocale, String sRefToMessageInError, String sOrigin, String sErrorDescription)
default com.helger.commons.error.IError	getAsError(Locale aContentLocale)
EEbmsErrorCategory	getCategory() Gets the value of the category property.
String	getErrorCode() Gets the value of the errorCode property.
com.helger.commons.text.display.IHasDisplayText	getErrorDetail() Gets the value of the errorDetail property.
EEbmsErrorSeverity	getSeverity() Gets the value of the severity property.
String	getShortDescription() Gets the value of the shortDescription property.

Method Detail

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:

possible object is String

getErrorDetail

@Nonnull
com.helger.commons.text.display.IHasDisplayText getErrorDetail()

Gets the value of the errorDetail property.

Returns:

possible object is String

getCategory

@Nonnull
EEbmsErrorCategory getCategory()

Gets the value of the category property.

Returns:

possible object is EEbmsErrorCategory

getAsError

@Nonnull
default com.helger.commons.error.IError getAsError(@Nonnull
                                                             Locale aContentLocale)

getAsEbms3Error

@Nonnull
default Ebms3Error getAsEbms3Error(@Nonnull
                                             Locale aContentLocale,
                                             @Nullable
                                             String sRefToMessageInError)

getAsEbms3Error

@Nonnull
default Ebms3Error getAsEbms3Error(@Nonnull
                                             Locale aContentLocale,
                                             @Nullable
                                             String sRefToMessageInError,
                                             @Nullable
                                             String sErrorDescription)

getAsEbms3Error

@Nonnull
default Ebms3Error getAsEbms3Error(@Nonnull
                                             Locale aContentLocale,
                                             @Nullable
                                             String sRefToMessageInError,
                                             @Nullable
                                             String sOrigin,
                                             @Nullable
                                             String sErrorDescription)

getAsEbms3Error

@Nonnull
default Ebms3Error getAsEbms3Error(@Nonnull
                                             Locale aContentLocale,
                                             @Nullable
                                             String sRefToMessageInError,
                                             @Nullable
                                             String sOrigin,
                                             @Nullable
                                             Ebms3Description aEbmsDescription)