org.mule.runtime.api.message

Interface ErrorType

All Superinterfaces:

Serializable

@NoImplement
public interface ErrorType
extends Serializable

An ErrorType describes an type of error that may be thrown by a mule component.

The error type has a string representation getIdentifier which is used directly by the user in the mule configuration.

Every error belongs to a namespace getNamespace in order to avoid collisions of error with the same string representation but that belong to different namespace getNamespace.

Error types may be an specialization of a more general error type in which case the getParentErrorType should return the more general error type. This is used when doing error type matching within error handlers so when selecting the general error type for error handling it will also handle the more specialized error types.

Method Summary

Modifier and Type	Method and Description
String	getIdentifier() Identifier of the error.
String	getNamespace() The namespace of the module where the error is defined.
ErrorType	getParentErrorType() An error can be an specific type of a more general error type in which case it must return the general error as result of calling getParentErrorType

Method Detail

getIdentifier

String getIdentifier()

Identifier of the error. Is the value that is meant to be used in the configuration.

Returns:

the string representation of the error.

getNamespace

String getNamespace()

The namespace of the module where the error is defined. For instance, for runtime errors the namespace is core.

Returns:

namespace of the module that defines this error.

getParentErrorType

ErrorType getParentErrorType()

An error can be an specific type of a more general error type in which case it must return the general error as result of calling getParentErrorType

Returns:

the parent error type.