com.pega.pegarules.pub.database

Class DatabaseException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.pega.pegarules.pub.PRException

com.pega.pegarules.pub.database.DatabaseException

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

BadClassDefinitionException, BadInputException, BadInstanceDataException, BadRoleException, BadRulesetException, BadTableMappingException, CacheException, ConfigurationException, ConnectionException, InitializationException, IntegrityConstraintViolationException, JTAException, LockFailureException, MultipleCircumstancePropertiesException, MultipleInstancesWithKeyException, MultipleRuleVersionException, NoRuleVersionWithoutCircumstanceException, RuleSaveNotSupportedException

public class DatabaseException
extends PRException

An exception in database processing. Many methods in this package throw a subclass of this exception to indicate an error.

The subclass ConnectionException (and its subclasses) represent connection errors, and the other subclasses represent operational errors.

In most cases, when an exception is thrown, the Processing Status is set to Error. Following are some subclasses of DatabaseException that are commonly used, and the messages typically used for the Processing Status error.

See the subclasses of this class for more information about specific exception classes.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT
static java.lang.String	VERSION

Fields inherited from class com.pega.pegarules.pub.PRException

mLookUpRuleMessages

Constructor Summary

Constructors

Constructor and Description
DatabaseException(int aSeverity, java.lang.String aDescr) Creates an exception with a severity and a message.
DatabaseException(java.lang.String aDescr) Creates a database exception with a given message.
DatabaseException(java.lang.Throwable aCause, int aSeverity, java.lang.String aDescr, java.lang.String aSQL, java.lang.String[] aSQLInserts) Creates a general database exception with a given severity, and with other information.
DatabaseException(java.lang.Throwable aCause, int aSeverity, java.lang.String aDescr, java.lang.String aSQL, java.lang.String[] aSQLInserts, java.lang.String aDBName, java.lang.String aOperation) Creates a general database exception with a given severity, and with other information, including db name and operation.
DatabaseException(java.lang.Throwable aCause, java.lang.String aDescr) Creates a database exception with a given message, caused by the given exception or error.
DatabaseException(java.lang.Throwable aCause, java.lang.String aMsgID, java.lang.String[] aMsgInserts, int aSeverity, java.lang.String aSQL, java.lang.String[] aSQLInserts) Creates a database exception with a given severity, and with other information.
DatabaseException(java.lang.Throwable aCause, java.lang.Throwable aSecCause, java.lang.String aMsgID, java.lang.String[] aMsgInserts, int aSeverity, java.lang.String aSQL, java.lang.String[] aSQLInserts) Creates a database exception with a given severity, and with other information.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDBName()
java.util.List<java.lang.Integer>	getIndexesOfFailedBatchOperation()
java.lang.String	getMessage() Gets the exception message in addition to the messages and stack traces of any causes
java.lang.String	getOperation()
java.lang.String	getSQL()
void	setDBName(java.lang.String aDbName)
void	setOperation(java.lang.String aOperation)
void	setSQL(java.lang.String aSQL) Associates this exception with a SQL statement.
void	setSQLInserts(java.lang.String[] aSQLInserts) Associates this exception with a list of SQL prepared statement insert values.

Methods inherited from class com.pega.pegarules.pub.PRException

isLookUpRuleMessages, setLookUpRuleMessages, toString

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

See Also:

Constant Field Values

VERSION

public static final java.lang.String VERSION

Constructor Detail

DatabaseException

public DatabaseException(java.lang.Throwable aCause,
                         java.lang.String aMsgID,
                         java.lang.String[] aMsgInserts,
                         int aSeverity,
                         java.lang.String aSQL,
                         java.lang.String[] aSQLInserts)

Creates a database exception with a given severity, and with other information. Sets the runtime status to aMsgID.

Parameters:

aCause - the exception that caused this, or null if none

aMsgID - the message to report

aMsgInserts - the message inserts, or null if none

aSeverity - the severity

aSQL - the SQL we were running when the problem occurred, or null if none

aSQLInserts - the inserts for the SQL we were running, or null if none

DatabaseException

public DatabaseException(java.lang.Throwable aCause,
                         java.lang.Throwable aSecCause,
                         java.lang.String aMsgID,
                         java.lang.String[] aMsgInserts,
                         int aSeverity,
                         java.lang.String aSQL,
                         java.lang.String[] aSQLInserts)

Creates a database exception with a given severity, and with other information. Sets the runtime status to aMsgID.

Parameters:

aCause - the exception that caused this, or null if none

aSecCause - a secondary exception that may have been covered

aMsgID - the message to report

aMsgInserts - the message inserts, or null if none

aSeverity - the severity

aSQL - the SQL we were running when the problem occurred, or null if none

aSQLInserts - the inserts for the SQL we were running, or null if none

DatabaseException

public DatabaseException(java.lang.Throwable aCause,
                         int aSeverity,
                         java.lang.String aDescr,
                         java.lang.String aSQL,
                         java.lang.String[] aSQLInserts)

Creates a general database exception with a given severity, and with other information. Sets the runtime status to Database-General.

Parameters:

aCause - the exception that caused this, or null if none

aSeverity - the severity

aDescr - a description of the problem

aSQL - the SQL we were running when the problem occurred, or null if none

aSQLInserts - the inserts for the SQL we were running, or null if none

DatabaseException

public DatabaseException(java.lang.Throwable aCause,
                         int aSeverity,
                         java.lang.String aDescr,
                         java.lang.String aSQL,
                         java.lang.String[] aSQLInserts,
                         java.lang.String aDBName,
                         java.lang.String aOperation)

Creates a general database exception with a given severity, and with other information, including db name and operation. Sets the runtime status to Database-General.

Parameters:

aCause - the exception that caused this, or null if none

aSeverity - the severity

aDescr - a description of the problem

aSQL - the SQL we were running when the problem occurred, or null if none

aSQLInserts - the inserts for the SQL we were running, or null if none

aDBName - the database in which the problem occurred

aOperation - the operation during which the problem occurred

DatabaseException

public DatabaseException(java.lang.String aDescr)

Creates a database exception with a given message.

Parameters:

aDescr - the message

DatabaseException

public DatabaseException(int aSeverity,
                         java.lang.String aDescr)

Creates an exception with a severity and a message. Sets the runtime status to Database-General.

Parameters:

aSeverity - the severity

aDescr - the message

DatabaseException

public DatabaseException(java.lang.Throwable aCause,
                         java.lang.String aDescr)

Creates a database exception with a given message, caused by the given exception or error. Sets the runtime status to Database-General.

Parameters:

aCause - the exception or error

aDescr - the message

Method Detail

setSQL

public void setSQL(java.lang.String aSQL)

Associates this exception with a SQL statement. This should be the SQL that "caused" the exception.

Parameters:

aSQL - the SQL

setSQLInserts

public void setSQLInserts(java.lang.String[] aSQLInserts)

Associates this exception with a list of SQL prepared statement insert values.

Parameters:

aSQLInserts - the insert values

getSQL

public java.lang.String getSQL()

Returns:

the SQL of this Exception

getMessage

public java.lang.String getMessage()

Gets the exception message in addition to the messages and stack traces of any causes

Overrides:

getMessage in class java.lang.Throwable

Returns:

Exception and cause messages as a single string

getDBName

public java.lang.String getDBName()

setDBName

public void setDBName(java.lang.String aDbName)

getOperation

public java.lang.String getOperation()

setOperation

public void setOperation(java.lang.String aOperation)

getIndexesOfFailedBatchOperation

public java.util.List<java.lang.Integer> getIndexesOfFailedBatchOperation()