Package com.ptc.windchill.esi.utl

Class ESIException

java.lang.Object

java.lang.Throwable

java.lang.Exception

wt.util.WTException

com.ptc.windchill.esi.utl.ESIException

All Implemented Interfaces:

Serializable, LocalizableMessage, Message

Direct Known Subclasses:

ESIMapException, ESINoTargetAssignmentException, ESIRendererException, ESIResponseMetaInfoException, MissingParameterException, PreReleaseValidationException

public class ESIException
extends WTException

Provide message wrapper for other ESI Exceptions

Supported API: true

Extendable: true

See Also:

• Serialized Form

Field Summary

Fields inherited from class wt.util.WTException

GETMESSAGE_LINE_SEPARATOR, LINE_SEPARATOR, SPACE_SEPARATOR, TOSTRING_LINE_SEPARATOR

Constructor Summary

Constructors

Constructor	Description
ESIException()	Default constructor Supported API: true
ESIException(int errorCode, String message)	Constructs a ESIException exception with the input message.
ESIException(int errorCode, Throwable t, String message)	Constructs a ESIException exception with a localizable standard message constructed from the bundle, key, and params.
ESIException(Exception e)	Get the localized message and the stack trace from the argument.
ESIException(String msg)	Constructs an ESIException with an input localizable standard message.
ESIException(String rb, String key, Object[] params)	Constructs a ESIException with a localizable standard message constructed from the bundle, key, and params.
ESIException(Throwable t, String rb, String key, Object[] params)	Constructs a ESIException with nested throwable, the bundle, key, and params.

Method Summary

Modifier and Type	Method	Description
int	getErrorCode()	Returns the error code.
void	setErrorCode(int errorCode)	Sets the error code.

Methods inherited from class wt.util.WTException

getAdditionalMessageArray, getAdditionalMessages, getAdditionalMessages, getExceptionIdentifier, getLocalizedMessage, getLocalizedMessage, getLocalizedMessage, getLocalizedMessage, getNestedExceptionString, getNestedExceptionString, getNestedThrowable, getStandardMessage, getStandardMessage, getWTMessage, printStackTrace, printStackTrace, printStackTrace, setLocalizedMessage, toString, toString

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getMessage, getStackTrace, getSuppressed, initCause, setStackTrace

Methods inherited from class java.lang.Object

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

Constructor Details

ESIException

public ESIException(Exception e)

Get the localized message and the stack trace from the argument. Store it in the localized message

Supported API: true

Parameters:

e -

ESIException

public ESIException()

Default constructor

Supported API: true

ESIException

public ESIException(String msg)

Constructs an ESIException with an input localizable standard message.

Supported API: true

Parameters:

msg -

ESIException

public ESIException(String rb,
 String key,
 Object[] params)

Constructs a ESIException with a localizable standard message constructed from the bundle, key, and params.

Supported API: true

Parameters:

rb - the resource bundle the key resides in

key - the key containing the message in the resource bundle

params - the parameters to substitute in the message

ESIException

public ESIException(Throwable t,
 String rb,
 String key,
 Object[] params)

Constructs a ESIException with nested throwable, the bundle, key, and params.

Supported API: true

Parameters:

t - the nested throwable

rb - the resource bundle the key resides in

key - the key containing the message in the resource bundle

params - the parameters to substitute in the message

ESIException

public ESIException(int errorCode,
 String message)

Constructs a ESIException exception with the input message. The input argument "errorCode" is used in "Pre_Release_Validate" workflow expression to take the appropriate path after its execution. Check the constants which starts with "EC_" in ESIConst for different error codes. e.g., when the "Pre_Release_Validate" workflow expression receives this exception with the error code ESIConst.EC_NO_VALID_PROMOTABLES, the OOTB workflow will get terminated.

Supported API: true

Parameters:

errorCode - - error code to decide the path after the execution of "Pre_Release_Validate" workflow expression.

message - - exception message

ESIException

public ESIException(int errorCode,
 Throwable t,
 String message)

Constructs a ESIException exception with a localizable standard message constructed from the bundle, key, and params. The input argument "errorCode" is used in "Pre_Release_Validate" workflow expression to take the appropriate path after its execution. Check the constants which starts with "EC_" in ESIConst for different error codes. e.g., when the "Pre_Release_Validate" workflow expression receives this exception with the error code ESIConst.EC_NO_VALID_PROMOTABLES, the OOTB workflow will get terminated.

Supported API: true

Parameters:

errorCode - - error code to decide the path after the execution of "Pre_Release_Validate" workflow expression.

t - - the throwable object

message - - exception message

Method Details

setErrorCode

public void setErrorCode(int errorCode)

Sets the error code.

Supported API: true

Parameters:

errorCode - the errorCode to set

getErrorCode

public int getErrorCode()

Returns the error code.

Supported API: true

Returns:

the errorCode