filenet.vw.api

Class VWServerException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

filenet.vw.api.VWException

filenet.vw.api.VWServerException

All Implemented Interfaces:

java.io.Serializable

public class VWServerException
extends VWException
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

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.Long	DB_REINIT_ERR "Database reinitialized -- all programs must log off and then logon again" Data for this error is stale

Constructor Summary

Constructors

Constructor and Description
VWServerException(java.lang.String aKey, java.lang.String dummy, java.lang.Long aTuple) Constructor
VWServerException(java.lang.String aKey, java.lang.String dummy, java.lang.Long aTuple, java.lang.Object arg0) Constructor
VWServerException(java.lang.String aKey, java.lang.String dummy, java.lang.Long aTuple, java.lang.Object[] arguments) Constructor
VWServerException(java.lang.String aKey, java.lang.String dummy, java.lang.Long aTuple, java.lang.Object arg0, java.lang.Object arg1) Constructor
VWServerException(java.lang.String aKey, java.lang.String dummy, java.lang.Long aTuple, java.lang.Object arg0, java.lang.Object arg1, java.lang.Object arg2) Constructor

Method Summary

Modifier and Type	Method and Description
java.lang.Long	getTuple() Retrieves the hex tuple from the exception associated with the server tuple.

Methods inherited from class filenet.vw.api.VWException

DescribeThrowableAndItsCause, DescribeThrowableAndItsCauseWithStackFrames, DescribeThrowableCompletely, getCauseClassName, getCauseDescription, getKey, getLocalizedMessage, getMessage, getRealCause, getRootCause, getStringFromKey, setCause, setIncludeRootCause, toString, tupleToSWGFormatMessageCode

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

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

Field Detail

DB_REINIT_ERR

public static java.lang.Long DB_REINIT_ERR

"Database reinitialized -- all programs must log off and then logon again" Data for this error is stale

Constructor Detail

VWServerException

public VWServerException(java.lang.String aKey,
                         java.lang.String dummy,
                         java.lang.Long aTuple)

Constructor

Parameters:

aKey - Key to use in looking up a resource in the VWExceptions file; an identifier of the form "vw.<package>.<id>" (such as, vw.server.exception1)

dummy - English version of resource string the application uses to generate the VWExceptions file

VWServerException

public VWServerException(java.lang.String aKey,
                         java.lang.String dummy,
                         java.lang.Long aTuple,
                         java.lang.Object arg0)

Constructor

Parameters:

aKey - A String containing the key to use in looking up the specified resource string.

dummy - A String containing the English version of the resource string the application uses to generate the VWException file.

aTuple - A Long value indicating the error code to assign to the exception.

arg0 - An Object containing the first argument to apply when formatting the resource string.

See Also:

String

VWServerException

public VWServerException(java.lang.String aKey,
                         java.lang.String dummy,
                         java.lang.Long aTuple,
                         java.lang.Object arg0,
                         java.lang.Object arg1)

Constructor

Parameters:

aKey - A String containing the key to use in looking up the specified resource string.

dummy - A String containing the English version of the resource string the application uses to generate the VWException file.

aTuple - A Long value indicating the error code to assign to the exception.

arg0 - An Object containing the first argument to apply when formatting the resource string.

arg1 - An Object containing the second argument to apply when formatting the resource string.

See Also:

String

VWServerException

public VWServerException(java.lang.String aKey,
                         java.lang.String dummy,
                         java.lang.Long aTuple,
                         java.lang.Object arg0,
                         java.lang.Object arg1,
                         java.lang.Object arg2)

Constructor

Parameters:

aKey - A String containing the key to use in looking up the specified resource string.

dummy - A String containing the English version of the resource string the application uses to generate the VWException file.

aTuple - A Long value indicating the error code to assign to the exception.

arg0 - An Object containing the first argument to apply when formatting the resource string.

arg1 - An Object containing the second argument to apply when formatting the resource string.

arg2 - An Object containing the third argument to apply when formatting the resource string.

See Also:

String

VWServerException

public VWServerException(java.lang.String aKey,
                         java.lang.String dummy,
                         java.lang.Long aTuple,
                         java.lang.Object[] arguments)

Constructor

Parameters:

aKey - A String containing the key to use in looking up the specified resource string.

dummy - A String containing the English version of the resource string the application uses to generate the VWException file.

aTuple - A Long value indicating the error code to assign to the exception.

arguments - An Object array containing a variable number of arguments to use in generating a string from a resource template string.

See Also:

String

Method Detail

getTuple

public java.lang.Long getTuple()

Retrieves the hex tuple from the exception associated with the server tuple.

Returns:

A Integer representing the exception tuple associated with the server exception, if the tuple is available; otherwise the method returns the default value for the exception tuple -0.