wt.eff.format
Class EffFormatException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          java.lang.RuntimeException
              wt.util.WTRuntimeException
                  wt.eff.format.EffFormatException

All Implemented Interfaces:

Serializable, LocalizableMessage, Message

public class EffFormatException
extends WTRuntimeException
implements Serializable

Provides an abstraction of an abnormal occurrence or error resulting while an effectivity format related operation is executed. This exception is thrown by the EffFormat classes during an abnormal occurence or error, from which a client is not expected to recover, and hence this is an unchecked exception.

Clients are not required to catch this exception, as there is not much the client can do once caught, although on certain occasions it can be caught, if the client and recover and act accordingly.

Exceptions can be localized through a given resource bundle, and other exceptions can be nested within an EffFormatException.


Supported API: true

Extendable: true

Since:

Windchill 9.0

See Also:

EffFormat, EffFormatService, Serialized Form

Constructor Summary

EffFormatException(String errorString)


Supported API: true

EffFormatException(Throwable t)


Supported API: true

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


Supported API: true

Method Summary

static EffFormatException	getInstanceForIllegalFormatSpecification(String effFormat, ObjectReference contextObjRef, String addInfo) Factory method that returns an EffFormatException with a standard error message constructed from the parameters.
static EffFormatException	getInstanceForIllegalParameterSpecification(String effFormat, String param, ObjectReference contextObjRef, String addInfo) Factory method that returns an EffFormatException with a standard error message constructed from the parameters.

Methods inherited from class wt.util.WTRuntimeException

getLocalizedMessage, getLocalizedMessage, getLocalizedMessage, getLocalizedMessage, getMessage, getNestedThrowable, printStackTrace, printStackTrace, printStackTrace, toString, toString

Methods inherited from class java.lang.Throwable

fillInStackTrace, getStackTrace, setStackTrace

Methods inherited from class java.lang.Object

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

Constructor Detail

EffFormatException

public EffFormatException(String errorString)

Supported API: true

Parameters:

errorString -

EffFormatException

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

Supported API: true

Parameters:

t -

rb -

key -

params -

EffFormatException

public EffFormatException(Throwable t)

Supported API: true

Parameters:

t -

Method Detail

getInstanceForIllegalParameterSpecification

public static EffFormatException getInstanceForIllegalParameterSpecification(String effFormat,
                                                                             String param,
                                                                             ObjectReference contextObjRef,
                                                                             String addInfo)

Factory method that returns an EffFormatException with a standard error message constructed from the parameters. This method is to be called when a format parameter is incorrectly specified.

Supported API: true

Parameters:

effFormat - the name of the effectivity this parameter applies to

param - the parameter that is incorrectly specified

contextObjRef - (Optional) An object reference to the effectivity context object, for logging purposes

addInfo - Optionally, specify a specific error string, that will help the user identify the problem more closely

Returns:

an EffFormatException object containing the error string constructed from the parameters

getInstanceForIllegalFormatSpecification

public static EffFormatException getInstanceForIllegalFormatSpecification(String effFormat,
                                                                          ObjectReference contextObjRef,
                                                                          String addInfo)

Factory method that returns an EffFormatException with a standard error message constructed from the parameters. This method is to be called when a format parameter is incorrectly specified.

Supported API: true

Parameters:

effFormat - the name of the effectivity this parameter applies to

contextObjRef - (Optional) An object reference to the effectivity context object, for logging purposes

addInfo - Optionally, specify a specific error string, that will help the user identify the problem more closely

Returns:

an EffFormatException object containing the error string constructed from the parameters