Process API

filenet.vw.api
Class VWException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by filenet.vw.api.VWException
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
VWServerException

public class VWException
extends java.lang.Exception
implements java.io.Serializable

This is the base class for all workflow exceptions. Use this class to access the resource strings an application uses to create the exceptions.

See Also:
Serialized Form

Constructor Summary
VWException(java.lang.String aKey, java.lang.String dummy)
          Constructor
VWException(java.lang.String aKey, java.lang.String dummy, java.lang.Object arg0)
          Constructor
VWException(java.lang.String aKey, java.lang.String dummy, java.lang.Object[] arguments)
          Constructor
VWException(java.lang.String aKey, java.lang.String dummy, java.lang.Object arg0, java.lang.Object arg1)
          Constructor
VWException(java.lang.String aKey, java.lang.String dummy, java.lang.Object arg0, java.lang.Object arg1, java.lang.Object arg2)
          Constructor
VWException(java.lang.Throwable cause)
          Constructor
 
Method Summary
static java.lang.String _get_FILE_AUTHOR()
          For FileNet internal use only, do not call.
static java.lang.String _get_FILE_DATE()
          For FileNet internal use only, do not call.
static java.lang.String _get_FILE_REVISION()
          For FileNet internal use only, do not call.
static java.lang.String DescribeThrowableAndItsCause(java.lang.Throwable t)
           
static java.lang.String DescribeThrowableAndItsCauseWithStackFrames(java.lang.Throwable t, int maxFrames)
           
static java.lang.String DescribeThrowableCompletely(java.lang.Throwable t)
           
 java.lang.String getCauseClassName()
          Returns the class name for the cause of this VWException.
 java.lang.String getCauseDescription()
          Returns the description for the cause of this VWException.
 java.lang.String getKey()
          Retrieves the key to an exception.
 java.lang.String getLocalizedMessage()
          Retrieves the localized version of an exception message.
 java.lang.String getMessage()
          Retrieves the associated string from the exceptions resource file.
static java.lang.Throwable getRealCause(java.lang.Throwable t)
          Retrieves the error number associated with the exception message.
 java.lang.Throwable getRootCause()
          Returns the root cause of this VWException or null if the cause is nonexistent or unknown.
static java.lang.String getStringFromKey(java.lang.String theKey)
          Retrieves the string in the exceptions resource file that corresponds to the exception key.
 void setCause(java.lang.Throwable cause)
          Initializes the cause of this VWException to the specified value.
 java.lang.String toString()
          Retrieves the associated string from the exceptions resource file.
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

VWException

public VWException(java.lang.Throwable cause)
Constructor

Parameters:
causeException - The cause exception that is being wrapped by this VWException.

VWException

public VWException(java.lang.String aKey,
                   java.lang.String dummy)
Constructor

Parameters:
aKey - Key to use in looking up a resource in the VWExceptions file; an identifier of the form "vw.<package>.<id>" (e.g., vw.server.exception1)
dummy - English version of resource string the application uses to generate the VWExceptions file

VWException

public VWException(java.lang.String aKey,
                   java.lang.String dummy,
                   java.lang.Object arg0)
Constructor

Parameters:
aKey - Key to use in looking up the specified resource string
dummy - English version of the resource string the application uses to generate the VWExceptions file
arg0 - First argument to apply when formatting the resource string

VWException

public VWException(java.lang.String aKey,
                   java.lang.String dummy,
                   java.lang.Object arg0,
                   java.lang.Object arg1)
Constructor

Parameters:
aKey - Key to use in looking up the specified resource string
dummy - English version of resource string the application uses to generate the VWExceptions file
arg0 - First argument to apply when formatting the resource string
arg1 - Second argument to apply when formatting the resource string

VWException

public VWException(java.lang.String aKey,
                   java.lang.String dummy,
                   java.lang.Object arg0,
                   java.lang.Object arg1,
                   java.lang.Object arg2)
Constructor

Parameters:
aKey - Key to use in looking up the specified resource string
dummy - English version of the resource string the application uses to generate the VWExceptions file
arg0 - First argument to apply when formatting the resource string
arg1 - Second argument to apply when formatting the resource string
arg2 - Third argument to apply when formatting the resource string

VWException

public VWException(java.lang.String aKey,
                   java.lang.String dummy,
                   java.lang.Object[] arguments)
Constructor

Parameters:
aKey - Key to use in looking up the specified resource string
dummy - English version of the resource string the application uses to generate the VWExceptions file
args - Variable number of arguments to use in generating a string from a resource template string
Method Detail

_get_FILE_DATE

public static java.lang.String _get_FILE_DATE()
For FileNet internal use only, do not call.


_get_FILE_AUTHOR

public static java.lang.String _get_FILE_AUTHOR()
For FileNet internal use only, do not call.


_get_FILE_REVISION

public static java.lang.String _get_FILE_REVISION()
For FileNet internal use only, do not call.


setCause

public void setCause(java.lang.Throwable cause)
Initializes the cause of this VWException to the specified value. (The cause is the throwable that caused this VWException to get thrown.) This method can be called at most once. It is generally called immediately after creating the VWException. If this VWException was created with VWException(Throwable), this method cannot be called even once.

Parameters:
cause - The cause (which is saved for later retrieval by the Throwable.getCause() method). A null value is permitted, and indicates that the cause is nonexistent or unknown.

getRootCause

public java.lang.Throwable getRootCause()
Returns the root cause of this VWException or null if the cause is nonexistent or unknown. (The root cause is the last exception in the exception chain.)

Returns:
The root cause of this throwable or null if the cause is nonexistent or unknown.

getCauseClassName

public java.lang.String getCauseClassName()
Returns the class name for the cause of this VWException.

Returns:
The class name for the cause of this VWException or null if the cause is nonexistent or unknown.

getCauseDescription

public java.lang.String getCauseDescription()
Returns the description for the cause of this VWException.

Returns:
The description for the cause of this VWException or null if the cause is nonexistent or unknown.

toString

public java.lang.String toString()
Retrieves the associated string from the exceptions resource file.

Overrides:
toString in class java.lang.Throwable
Returns:
A string representing the exception file's associated string, if the string is available; otherwise the method returns the default value for the exception key.
See Also:
getStringFromKey( String ), getKey()

getMessage

public java.lang.String getMessage()
Retrieves the associated string from the exceptions resource file.

Overrides:
getMessage in class java.lang.Throwable
Returns:
A string representing the exception file's associated string, if the string is available; otherwise the method returns the default value for the exception key.
See Also:
getStringFromKey( String )

getKey

public java.lang.String getKey()
Retrieves the key to an exception.

Returns:
The key to an exception.

getStringFromKey

public static java.lang.String getStringFromKey(java.lang.String theKey)
Retrieves the string in the exceptions resource file that corresponds to the exception key.

Returns:
The string that corresponds to the resource key, as defined in the exceptions resource file.

getLocalizedMessage

public java.lang.String getLocalizedMessage()
Retrieves the localized version of an exception message.

Overrides:
getLocalizedMessage in class java.lang.Throwable
Returns:
The localized version of an exception message.

getRealCause

public static java.lang.Throwable getRealCause(java.lang.Throwable t)
Retrieves the error number associated with the exception message. This value is set to for server exceptions otherwise will return 0

Returns:
error number associated with exception message. public long getErrorTuple() { return errTupleNumber; }

DescribeThrowableAndItsCause

public static java.lang.String DescribeThrowableAndItsCause(java.lang.Throwable t)

DescribeThrowableCompletely

public static java.lang.String DescribeThrowableCompletely(java.lang.Throwable t)

DescribeThrowableAndItsCauseWithStackFrames

public static java.lang.String DescribeThrowableAndItsCauseWithStackFrames(java.lang.Throwable t,
                                                                           int maxFrames)

Process API

© Copyright IBM Corporation 2002, 2008. All rights reserved.