atg.droplet

Class DropletFormException

java.lang.Object

java.lang.Throwable

java.lang.Exception

javax.servlet.ServletException

atg.droplet.DropletException

atg.droplet.DropletFormException

All Implemented Interfaces:

java.io.Serializable

public class DropletFormException
extends DropletException

Represents an exception that might occur when delivering a droplet event.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string

Constructor Summary

Constructors

Constructor and Description
DropletFormException(java.lang.String pStr, java.lang.String pPath) Constructs a new DropletFormException with the given explanation
DropletFormException(java.lang.String pStr, java.lang.String pPath, java.lang.String pMessageCode) Constructs a new DropletFormException with the given explanation.
DropletFormException(java.lang.String pStr, java.lang.String pPath, java.lang.String pMessageCode, java.lang.String pInputErrorCode) Constructs a new DropletFormException with the given explanation.
DropletFormException(java.lang.String pStr, java.lang.Throwable pRootCause, java.lang.String pPath) Constructs a new DropletFormException with the given explanation and root exception.
DropletFormException(java.lang.String pStr, java.lang.Throwable pRootCause, java.lang.String pPath, java.lang.String pMessageCode) Constructs a new DropletFormException with the given explanation, root exception, path name to the property that caused the exception, and the messageCode for the exception.
DropletFormException(java.lang.String pStr, java.lang.Throwable pRootCause, java.lang.String pPath, java.lang.String pMessageCode, java.lang.String pInputErrorCode) Constructs a new DropletFormException with the given explanation, root exception, path name to the property that caused the exception, the messageCode for the exception, and the inputErrorCode for the exception.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getPropertyName() Returns the name of the property that generated this exception
java.lang.String	getPropertyPath() Returns the path name of the property that generated this exception
java.lang.String	toString() Returns a description of this DropletException object.

Methods inherited from class atg.droplet.DropletException

getErrorCode, getInputErrorCode

Methods inherited from class javax.servlet.ServletException

getRootCause

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

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

Constructor Detail

DropletFormException

public DropletFormException(java.lang.String pStr,
                            java.lang.String pPath)

Constructs a new DropletFormException with the given explanation

Parameters:

pStr - explanation for form exception

pPath - full path to the form handler property associated with the exception, e.g. /foo/bar.name

DropletFormException

public DropletFormException(java.lang.String pStr,
                            java.lang.String pPath,
                            java.lang.String pMessageCode)

Constructs a new DropletFormException with the given explanation. You can pass in an optional messageCode field. This is a one word description of the error. If you omit this description, the class name of the exception is used instead.

Parameters:

pStr - explanation for form exception

pPath - full path to the form handler property associated with the exception, e.g. /foo/bar.name

pMessageCode - message code for this exception

DropletFormException

public DropletFormException(java.lang.String pStr,
                            java.lang.String pPath,
                            java.lang.String pMessageCode,
                            java.lang.String pInputErrorCode)

Constructs a new DropletFormException with the given explanation. You can pass in an optional messageCode field. This is a one word description of the error. If you omit this description, the class name of the exception is used instead. You can also pass an input error code that indicates this error was as a result of bad input rather than a more general server error.

Parameters:

pStr - explanation for form exception

pPath - full path to the form handler property associated with the exception, e.g. /foo/bar.name

pMessageCode - message code for this exception

pInputErrorCode - the input error code for this exception if the exception was as a result of bad input

DropletFormException

public DropletFormException(java.lang.String pStr,
                            java.lang.Throwable pRootCause,
                            java.lang.String pPath)

Constructs a new DropletFormException with the given explanation and root exception.

Parameters:

pStr - explanation for form exception

pRootCause - root exception

pPath - full path to the form handler property associated with the exception, e.g. /foo/bar.name

DropletFormException

public DropletFormException(java.lang.String pStr,
                            java.lang.Throwable pRootCause,
                            java.lang.String pPath,
                            java.lang.String pMessageCode)

Constructs a new DropletFormException with the given explanation, root exception, path name to the property that caused the exception, and the messageCode for the exception.

Parameters:

pStr - explanation for form exception

pRootCause - root exception

pPath - full path to the form handler property associated with the exception, e.g. /foo/bar.name

pMessageCode - message code for this exception

DropletFormException

public DropletFormException(java.lang.String pStr,
                            java.lang.Throwable pRootCause,
                            java.lang.String pPath,
                            java.lang.String pMessageCode,
                            java.lang.String pInputErrorCode)

Constructs a new DropletFormException with the given explanation, root exception, path name to the property that caused the exception, the messageCode for the exception, and the inputErrorCode for the exception.

Parameters:

pStr - explanation for form exception

pRootCause - root exception

pPath - full path to the form handler property associated with the exception, e.g. /foo/bar.name

pMessageCode - message code for this exception

pInputErrorCode - the input error code for this exception if the exception was as a result of bad input

Method Detail

getPropertyPath

public java.lang.String getPropertyPath()

Returns the path name of the property that generated this exception

getPropertyName

public java.lang.String getPropertyName()

Returns the name of the property that generated this exception

toString

public java.lang.String toString()

Description copied from class: DropletException

Returns a description of this DropletException object.

Overrides:

toString in class DropletException