de.aristaflow.adept2.model.runtimeenvironment

Class ApplicationEnvironmentException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

de.aristaflow.adept2.model.runtimeenvironment.ApplicationEnvironmentException

All Implemented Interfaces:

java.io.Serializable

public class ApplicationEnvironmentException
extends java.lang.RuntimeException

Exception indicating the failing of an application / activity due to an erroneous environment, for instance, required parameters are missing or wrong or the GUI-context can not be used. Therefore this exception signals failures that are caused outside of the component, which can be other components or the process management system.
This exception encapsulates an ADEPT2-error code, a human readable message explaining the failure and optionally the exception that caused the failure.

Author:

Kevin Goeser, Ulrich Kreher

See Also:

ApplicationErrorCodes, Serialized Form

Constructor Summary

Constructors

Constructor and Description
ApplicationEnvironmentException(java.lang.String errorMessage, long errorCode) Creates a new ApplicationEnvironmentException containing the designated information which is a human readable message and the ADEPT2-error code.
ApplicationEnvironmentException(java.lang.String errorMessage, long errorCode, java.lang.Throwable cause) Creates a new ApplicationEnvironmentException containing the designated information which is a human readable message and the ADEPT2-error code.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCompleteStackTrace() Gets the complete stack trace of this exception as it would be printed to a print stream.
long	getErrorCode() Returns the well-defined ADEPT2-error code.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ApplicationEnvironmentException

public ApplicationEnvironmentException(java.lang.String errorMessage,
                                       long errorCode)

Creates a new ApplicationEnvironmentException containing the designated information which is a human readable message and the ADEPT2-error code.

Parameters:

errorMessage - A human readable error message for this exception.

errorCode - The well-defined ADEPT2-error code.

ApplicationEnvironmentException

public ApplicationEnvironmentException(java.lang.String errorMessage,
                                       long errorCode,
                                       java.lang.Throwable cause)

Creates a new ApplicationEnvironmentException containing the designated information which is a human readable message and the ADEPT2-error code.

Parameters:

errorMessage - A human readable error message for this exception.

errorCode - The well-defined ADEPT2-error code.

cause - The cause for the failing of the application, for instance, another exception.

Method Detail

getErrorCode

public long getErrorCode()

Returns the well-defined ADEPT2-error code.

Returns:

The well-defined ADEPT2-error code.

getCompleteStackTrace

public java.lang.String getCompleteStackTrace()

Gets the complete stack trace of this exception as it would be printed to a print stream.

Returns:

The complete stack trace of this exception as it would be printed to a print stream.