public interface

WebBeanError

com.microstrategy.web.beans.WebBeanError
Known Indirect Subclasses

Class Overview

This interface exposes the necessary methods to retrieve backend error code and error message when any of the Web Beans is interacting with the backend server.

Transform implementor uses this interface to determine whether there is any error occurred when a WebBean was collecting its data.

Summary

Public Methods
abstract Throwable getCause()
Return the cause of the error, if there is any available.
abstract int getErrorCode()
Returns the error code to the caller.
abstract String getErrorMessage()
Return the error message to the caller.

Public Methods

public abstract Throwable getCause ()

Return the cause of the error, if there is any available.

Returns
  • the cause of the error, if available. Can be null, if there is no embedded exception available.

public abstract int getErrorCode ()

Returns the error code to the caller. By default the error code is zero.

Returns
  • the error code set by the last operation on the bean

public abstract String getErrorMessage ()

Return the error message to the caller.

Returns
  • the error message set by the last operation on the bean.