ifs.fnd.base

Class DatabaseException

java.lang.Object

java.lang.Throwable

java.lang.Exception

ifs.fnd.base.IfsException

ifs.fnd.base.ApplicationException

ifs.fnd.base.DatabaseException

All Implemented Interfaces:

java.io.Serializable

public class DatabaseException
extends ApplicationException

Exception re-thrown by the framework from the database/storage layer. A DatabaseException can be caught by application code (for example a unique key constraint). Example:

    ...
    catch (DatabaseException e) {
       if (e.getErrorType.equals(DatabaseException.UNIQUE_CONSTRAINT)) {
          String recName = e.getRecordName();
          ...
       }
    }
 

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DatabaseException.ErrorType Inner class representing error types

Field Summary

Fields

Modifier and Type	Field and Description
static DatabaseException.ErrorType	INSTANCE_NOT_FOUND Thrown when the entity "Get" operation fails (when no instance is available).
static DatabaseException.ErrorType	NULL_VALUE_CONSTRAINT Thrown when trying to insert/update null in a column with a NOT NULL constraint.
static DatabaseException.ErrorType	TABLE_DOES_NOT_EXIST Thrown when a table or view does not exist.
static DatabaseException.ErrorType	UNIQUE_CONSTRAINT Thrown when a unique constraint exception is thrown from database.

Fields inherited from class ifs.fnd.base.IfsException

APPLICATION_ERROR, DATABASE_ERROR, ENCRYPTION_ERROR, error, LICENSE_VIOLATION_ERROR, MANUAL_DECISION, NOT_LOGGED_ON_ERROR, PARSE_ERROR, SECURITY_ERROR, SYSTEM_ERROR, TIMEOUT_ERROR, UNKNOWN, USER_ABORT, VALIDATION_ERROR

Constructor Summary

Constructors

Constructor and Description
DatabaseException(DatabaseException.ErrorType errorType, FndTranslatableText msg) Create a new instance of DatabaseException.
DatabaseException(DatabaseException.ErrorType errorType, FndTranslatableText msg, java.lang.String recordName) Create a new instance of DatabaseException.
DatabaseException(DatabaseException.ErrorType errorType, java.lang.String msg) Create a new instance of DatabaseException.
DatabaseException(DatabaseException.ErrorType errorType, java.lang.String msg, java.lang.String recordName) Create a new instance of DatabaseException.

Method Summary

Methods

Modifier and Type	Method and Description
DatabaseException.ErrorType	getErrorType() Return the type of error.
java.lang.String	getExtraInfo() Get the detailed SQL error
java.lang.String	getRecordName() If this exception was thrown in the context of a entity save method, this method will return the name of the record being saved when the exception was thrown (if available).
boolean	hasRecordName() Check if the record name has been set on this exception.
void	setExtraInfo(java.lang.String info) Set the detailed SQL error
void	setRecordName(java.lang.String recordName) Set the name of the offending record.

Methods inherited from class ifs.fnd.base.IfsException

error, getMessage, getTranslationID, getType, runtimeError

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, 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

Field Detail

UNIQUE_CONSTRAINT

public static final DatabaseException.ErrorType UNIQUE_CONSTRAINT

Thrown when a unique constraint exception is thrown from database. (Unique index violation)

NULL_VALUE_CONSTRAINT

public static final DatabaseException.ErrorType NULL_VALUE_CONSTRAINT

Thrown when trying to insert/update null in a column with a NOT NULL constraint.

INSTANCE_NOT_FOUND

public static final DatabaseException.ErrorType INSTANCE_NOT_FOUND

Thrown when the entity "Get" operation fails (when no instance is available).

TABLE_DOES_NOT_EXIST

public static final DatabaseException.ErrorType TABLE_DOES_NOT_EXIST

Thrown when a table or view does not exist.

Constructor Detail

DatabaseException

public DatabaseException(DatabaseException.ErrorType errorType,
                 FndTranslatableText msg,
                 java.lang.String recordName)

Create a new instance of DatabaseException. The original error message will be combined with the serialized form of the error type to form a new error message.

Parameters:

errorType - Type of error. (Must never be null!)

msg - Original database error message.

recordName - Name of the record causing this exception.

Since:

4.1.0

DatabaseException

public DatabaseException(DatabaseException.ErrorType errorType,
                 FndTranslatableText msg)

Create a new instance of DatabaseException. The original error message will be combined with the serialized form of the error type to form a new error message.

Parameters:

errorType - Type of error. (Must never be null!)

msg - Original database error message.

Since:

4.1.0

DatabaseException

public DatabaseException(DatabaseException.ErrorType errorType,
                 java.lang.String msg,
                 java.lang.String recordName)

Create a new instance of DatabaseException. The original error message will be combined with the serialized form of the error type to form a new error message.

Parameters:

errorType - Type of error. (Must never be null!)

msg - Original database error message.

recordName - Name of the record causing this exception.

DatabaseException

public DatabaseException(DatabaseException.ErrorType errorType,
                 java.lang.String msg)

Create a new instance of DatabaseException. The original error message will be combined with the serialized form of the error type to form a new error message.

Parameters:

errorType - Type of error. (Must never be null!)

msg - Original database error message.

Method Detail

setRecordName

public void setRecordName(java.lang.String recordName)

Set the name of the offending record.

Parameters:

recordName - Name of the record.

getRecordName

public java.lang.String getRecordName()

If this exception was thrown in the context of a entity save method, this method will return the name of the record being saved when the exception was thrown (if available).

Returns:

record name or "" if the record name was not available.

hasRecordName

public boolean hasRecordName()

Check if the record name has been set on this exception.

Returns:

true if a record name is available.

getErrorType

public DatabaseException.ErrorType getErrorType()

Return the type of error.

Returns:

Type of database error (such as UNIQUE_CONSTRAINT).

getExtraInfo

public java.lang.String getExtraInfo()

Get the detailed SQL error

Overrides:

getExtraInfo in class IfsException

Returns:

String containing detailed SQL error

setExtraInfo

public void setExtraInfo(java.lang.String info)

Set the detailed SQL error

Parameters:

info - String containing detailed SQL error