com.highqsoft.interfaces.fwk

Interface FwkExceptionInterface

All Superinterfaces:

FwkInterface, FwkPresentationInterface, java.io.Serializable

All Known Implementing Classes:

FwkException

public interface FwkExceptionInterface
extends FwkPresentationInterface

The FwkExceptionInterface decribes the basic functionality of Exceptions.

Since:

$Date: 2017/04/28 08:47:43 $

Version:

$Revision: 1.11 $

Author:

HighQSoft GmbH

See Also:

Field Summary

Fields

Modifier and Type	Field and Description
static int	ERROR Constant identifier to generate EXTERNAL_ERROR exception.
static int	INFORMATIONAL Constant identifier to generate EXTERNAL_INFORMATION exception.
static int	WARNING Constant identifier to generate EXTERNAL_WARNING exception.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getClassName() Get the sourcecode filename of the exception.
java.lang.String	getCodeVersion() Get the revision of the sourcecode file of the exception.
java.lang.String	getFilename() Get the current exception source filename.
java.lang.String	getIdent() Get the current ident of the exception.
int	getNumber() Get the error number of the exception.
java.lang.String	getParameter() Get the parameter string of the exception.
java.lang.Object	getSourceObject() Get the source object of the exception.
java.lang.Throwable	getSourceThrowable() Get the source throwable of the exception.
void	setClassName(java.lang.String className) Set the class name of the source of the exception.
void	setCodeVersion(java.lang.String newVersion) Set the revision of the sourcecode file of the exception.
void	setFilename(java.lang.String newFilename) Set the filename where the exception was thrown.
void	setIdent(java.lang.String newIdent) Set the identification of the exception.
void	setNumber(int number) Set the error number of the exception.
void	setParameter(java.lang.String newParameter) Set the parameter string of the exception.
void	setSourceObject(java.lang.Object srcObject) Set the source object of the exception.
void	setSourceThrowable(java.lang.Throwable srcThrowable) Set the source throwable of the exception.
void	write() Write the exception.

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkPresentationInterface

getPresentationString, getPresentationString

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkInterface

getVersion, release

Field Detail

INFORMATIONAL

static final int INFORMATIONAL

Constant identifier to generate EXTERNAL_INFORMATION exception.

See Also:

Constant Field Values

WARNING

static final int WARNING

Constant identifier to generate EXTERNAL_WARNING exception.

See Also:

Constant Field Values

ERROR

static final int ERROR

Constant identifier to generate EXTERNAL_ERROR exception.

See Also:

Constant Field Values

Method Detail

getClassName

java.lang.String getClassName()

Get the sourcecode filename of the exception.

Returns:

The sourcecode filename of the exception.

See Also:

setFilename

getCodeVersion

java.lang.String getCodeVersion()

Get the revision of the sourcecode file of the exception.

Returns:

The revision string of the exception.

See Also:

setCodeVersion

getFilename

java.lang.String getFilename()

Get the current exception source filename.

Returns:

The the exception source filename.

See Also:

setFilename

getIdent

java.lang.String getIdent()

Get the current ident of the exception.

Returns:

The identification string of the exception.

See Also:

setIdent

getNumber

int getNumber()

Get the error number of the exception.

Returns:

The error number of the exception.

See Also:

setNumber

getParameter

java.lang.String getParameter()

Get the parameter string of the exception.

Returns:

The parameter string of the exception.

See Also:

setParamter

getSourceThrowable

java.lang.Throwable getSourceThrowable()

Get the source throwable of the exception.

Returns:

The source throwable of the message.

See Also:

setSourceThrowable

getSourceObject

java.lang.Object getSourceObject()

Get the source object of the exception.

Returns:

The source object of the message.

See Also:

setSourceObject

setClassName

void setClassName(java.lang.String className)

Set the class name of the source of the exception.

Parameters:

filename - The source class name of the exception.

See Also:

getFilename

setCodeVersion

void setCodeVersion(java.lang.String newVersion)

Set the revision of the sourcecode file of the exception.

Parameters:

revision - The version of the code file.

See Also:

getCodeVersion

setFilename

void setFilename(java.lang.String newFilename)

Set the filename where the exception was thrown.

Parameters:

filename - The name of the file.

See Also:

getFilename

setIdent

void setIdent(java.lang.String newIdent)

Set the identification of the exception.

Parameters:

ident - The new uniq identifier of the exception.

See Also:

getIdent

setNumber

void setNumber(int number)

Set the error number of the exception. Use the predefined error codes.

Parameters:

number - The new error number of the exception.

See Also:

getNumber

setParameter

void setParameter(java.lang.String newParameter)

Set the parameter string of the exception.

Parameters:

parameter - The new parameter string of the exception.

See Also:

getParameter

setSourceObject

void setSourceObject(java.lang.Object srcObject)

Set the source object of the exception.

Parameters:

srcObject - The source object of the exception.

See Also:

getSourceObject

setSourceThrowable

void setSourceThrowable(java.lang.Throwable srcThrowable)

Set the source throwable of the exception.

Parameters:

srcThrowable - The source throwable of the exception.

See Also:

getSourceThrowable

write

void write()

Write the exception.