Package com.helger.phase4.error

Interface IEbmsError

All Known Implementing Classes:

EbmsError, EEbmsError

public interface IEbmsError

Base interface for a single EBMS error

Author:

Philip Helger

Method Summary

Modifier and Type	Method	Description
default Ebms3ErrorBuilder	errorBuilder(Locale aContentLocale)	Create a new Ebms3ErrorBuilder with the information of this element.
default Ebms3Error	getAsEbms3Error(Locale aContentLocale, String sRefToMessageInError)	Deprecated, for removal: This API element is subject to removal in a future version.
default Ebms3Error	getAsEbms3Error(Locale aContentLocale, String sRefToMessageInError, String sErrorDetails)	Deprecated, for removal: This API element is subject to removal in a future version.
default Ebms3Error	getAsEbms3Error(Locale aContentLocale, String sRefToMessageInError, String sOrigin, Ebms3Description aEbmsDescription)	Deprecated, for removal: This API element is subject to removal in a future version.
default Ebms3Error	getAsEbms3Error(Locale aContentLocale, String sRefToMessageInError, String sOrigin, String sDetails)	Deprecated, for removal: This API element is subject to removal in a future version.
default com.helger.commons.error.IError	getAsError(Locale aContentLocale)	Deprecated, for removal: This API element is subject to removal in a future version.
EEbmsErrorCategory	getCategory()	Gets the value of the category property.
com.helger.commons.text.display.IHasDisplayText	getDescription()	Gets the value of the description property.
String	getErrorCode()	Gets the value of the errorCode property.
default com.helger.commons.text.display.IHasDisplayText	getErrorDetail()	Deprecated, for removal: This API element is subject to removal in a future version. Use getDescription() instead
EEbmsErrorSeverity	getSeverity()	Gets the value of the severity property.
String	getShortDescription()	Gets the value of the shortDescription property.

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.commons.text.display.IHasDisplayText getDescription()

Gets the value of the description property.

Returns:

The multilingual description.

Since:

2.6.0

getErrorDetail

@Nonnull
@Deprecated(forRemoval=true,
            since="2.6.0")
default com.helger.commons.text.display.IHasDisplayText getErrorDetail()

Deprecated, for removal: This API element is subject to removal in a future version.

Use getDescription() instead

Gets the value of the errorDetail property.

Returns:

The multilingual description.

getCategory

@Nonnull
EEbmsErrorCategory getCategory()

Gets the value of the category property.

Returns:

possible object is EEbmsErrorCategory

errorBuilder

@Nonnull
default 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

getAsError

@Nonnull
@Deprecated(forRemoval=true,
            since="2.6.0")
@UnsupportedOperation
default com.helger.commons.error.IError getAsError(@Nonnull
 Locale aContentLocale)

Deprecated, for removal: This API element is subject to removal in a future version.

Convert the EBMS Error into an IError.

Parameters:

aContentLocale - The locale used to resolve the error text, in case the text is multilingual. The locale may be ignored.

Returns:

The created IError.

getAsEbms3Error

@Nonnull
@Deprecated(forRemoval=true,
            since="2.6.0")
default Ebms3Error getAsEbms3Error(@Nonnull
 Locale aContentLocale,
 @Nullable
 String sRefToMessageInError)

Deprecated, for removal: This API element is subject to removal in a future version.

getAsEbms3Error

@Nonnull
@Deprecated(forRemoval=true,
            since="2.6.0")
default Ebms3Error getAsEbms3Error(@Nonnull
 Locale aContentLocale,
 @Nullable
 String sRefToMessageInError,
 @Nullable
 String sErrorDetails)

Deprecated, for removal: This API element is subject to removal in a future version.

getAsEbms3Error

@Nonnull
@Deprecated(forRemoval=true,
            since="2.6.0")
default Ebms3Error getAsEbms3Error(@Nonnull
 Locale aContentLocale,
 @Nullable
 String sRefToMessageInError,
 @Nullable
 String sOrigin,
 @Nullable
 String sDetails)

Deprecated, for removal: This API element is subject to removal in a future version.

getAsEbms3Error

@Nonnull
@Deprecated(forRemoval=true,
            since="2.6.0")
default Ebms3Error getAsEbms3Error(@Nonnull
 Locale aContentLocale,
 @Nullable
 String sRefToMessageInError,
 @Nullable
 String sOrigin,
 @Nullable
 Ebms3Description aEbmsDescription)

Deprecated, for removal: This API element is subject to removal in a future version.