com.pega.pegarules.pub

Class PRException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.pega.pegarules.pub.PRException

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

ColumnPopulationException, DatabaseException, FirstUseAssemblerException, InvalidConfigurationException, InvalidLocaleException, InvalidStreamError, NotSupportedException, PRDataPagePoolException, PRNoSuchChildException, PRObjectWrapperException, PRTimeoutExpiredException

public class PRException
extends java.lang.Exception

Basic exception used by PegaRULES classes. Exceptions of this nature must be declared with throws.

Version:

$Revision: 79395 $ $Date: 2014-01-24 03:09:40 -0500 (Fri, 24 Jan 2014) $

Author:

Gabe Ernst-Edwards

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT
static VicariousThreadLocal<java.lang.Boolean>	mLookUpRuleMessages
static java.lang.String	VERSION

Constructor Summary

Constructors

Constructor and Description
PRException() Default constructor with no message.
PRException(int aSeverity) Constructor used to specify a severity.
PRException(int aSeverity, java.lang.String aMessageName, java.lang.String aMessageParms) Constructor with a severity, message name and message parameters.
PRException(int aSeverity, java.lang.String aMessageName, java.lang.String aMessageParms, java.lang.Throwable aCause) Constructor with a severity, message name, message parameters, and a causing exception.
PRException(java.lang.String aMessage) Constructor with a message.
PRException(java.lang.String aMessageName, java.lang.String aMessageParms) Constructor with a message name and message parameters.
PRException(java.lang.String aMessageName, java.lang.String aMessageParms, java.lang.Throwable t) Constructor with a message name and message parameters.
PRException(java.lang.String aMessage, java.lang.Throwable aCause) Creates an exception with a given message, caused by the given exception or error.
PRException(java.lang.Throwable aCause) Creates an exception that is caused by a particular Throwable.

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	isLookUpRuleMessages()
static boolean	setLookUpRuleMessages(boolean lookUpRuleMessages)
java.lang.String	toString() Returns a (short) description of this throwable.

Methods inherited from class java.lang.Throwable

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

mLookUpRuleMessages

public static final VicariousThreadLocal<java.lang.Boolean> mLookUpRuleMessages

Constructor Detail

PRException

public PRException()

Default constructor with no message.

PRException

public PRException(java.lang.Throwable aCause)

Creates an exception that is caused by a particular Throwable.

Parameters:

aCause - the Throwable that caused this exception

PRException

public PRException(int aSeverity)

Constructor used to specify a severity.

Parameters:

aSeverity - severity of this error. See ProcessingStatus for more options.

PRException

public PRException(java.lang.String aMessage)

Constructor with a message. The severity of this exception defaults to ProcessingStatus.SEVERITY_FAIL.

Parameters:

aMessage - key to a Rule-Message instance, or simply a message. If it isn't a Rule-Message key, an instance may be written to Log-UndefinedMessages (see ProcessingStatus.logMissingMessages()).

PRException

public PRException(java.lang.String aMessage,
           java.lang.Throwable aCause)

Creates an exception with a given message, caused by the given exception or error. The severity of this exception defaults to ProcessingStatus.SEVERITY_FAIL.

Parameters:

aCause - the exception or error

aMessage - key to a Rule-Message instance, or simply a message. If it isn't a Rule-Message key, an instance may be written to Log-UndefinedMessages

See Also:

ProcessingStatus.logMissingMessages()

PRException

public PRException(java.lang.String aMessageName,
           java.lang.String aMessageParms)

Constructor with a message name and message parameters. The severity of this exception defaults to ProcessingStatus.SEVERITY_FAIL.

Parameters:

aMessageName - key to a Rule-Message instance, or simply a message. If it isn't a Rule-Message key, an instance may be written to Log-UndefinedMessages (see ProcessingStatus.logMissingMessages()).

aMessageParms - parameters to the Rule-Message (may be null)

PRException

public PRException(java.lang.String aMessageName,
           java.lang.String aMessageParms,
           java.lang.Throwable t)

Constructor with a message name and message parameters. The severity of this exception defaults to ProcessingStatus.SEVERITY_FAIL.

Parameters:

aMessageName - key to a Rule-Message instance, or simply a message. If it isn't a Rule-Message key, an instance may be written to Log-UndefinedMessages (see ProcessingStatus.logMissingMessages()).

aMessageParms - parameters to the Rule-Message (may be null)

t - Cause of exception

PRException

public PRException(int aSeverity,
           java.lang.String aMessageName,
           java.lang.String aMessageParms)

Constructor with a severity, message name and message parameters.

Parameters:

aSeverity - severity of this error. See ProcessingStatus for more options.

aMessageName - key to a Rule-Message instance, or simply a message. If it isn't a Rule-Message key, an instance may be written to Log-UndefinedMessages (see ProcessingStatus.logMissingMessages()).

aMessageParms - parameters to the Rule-Message (may be null)

PRException

public PRException(int aSeverity,
           java.lang.String aMessageName,
           java.lang.String aMessageParms,
           java.lang.Throwable aCause)

Constructor with a severity, message name, message parameters, and a causing exception.

Parameters:

aSeverity - severity of this error. See ProcessingStatus for more options.

aMessageName - key to a Rule-Message instance, or simply a message. If it isn't a Rule-Message key, an instance may be written to Log-UndefinedMessages (see ProcessingStatus.logMissingMessages()).

aMessageParms - parameters to the Rule-Message (may be null)

aCause -

Method Detail

toString

public java.lang.String toString()

Returns a (short) description of this throwable. (used by Throwable.printStackTrace to describe the exception)

Overrides:

toString in class java.lang.Throwable

Returns:

a string representation of this throwable.

isLookUpRuleMessages

public static boolean isLookUpRuleMessages()

setLookUpRuleMessages

public static boolean setLookUpRuleMessages(boolean lookUpRuleMessages)