Class actuate.Exception

A container for an uncategorized exception that also supports specific exceptions. Exception provides an object to pass to a callback function or event handler when an exception occurs. The Exception object contains references to the exception's origin, description, and messages.
Member of: actuate.

Class Summary
Constructor Attributes	Constructor Name and Description
	actuate.Exception() Constructs an Exception object.

Field Summary
Field Attributes	Field Name and Description
<static> <constant>	ERR_CLIENT Exception type for a client-side error
<static> <constant>	ERR_SERVER Exception type for a server error
<static> <constant>	ERR_USAGE Exception type for an api usage error

Method Summary
Method Attributes	Method Name and Description
	getDescription() Returns a description: SOAP string for ERR_SERVER fileName+number+stack for ERR_CLIENT (Firefox only) Anything set when creating this object for ERR_USER
	getErrCode() Returns the error code for ERR_SERVER.
	getMessage() Returns a short message about the exception.
	getType() Returns the type of exception error.
	isExceptionType(exceptionType) Returns whether this exception instance is of the given type.

Class Detail

actuate.Exception()

Constructs an Exception object. The exceptions are divided into three types, which determine the contents of the Exception object. These types are:

actuate.Exception.ERR_CLIENT: Exception type for a client-side error
actuate.Exception.ERR_SERVER: Exception type for a server error
actuate.Exception.ERR_USAGE: Exception type for a JSAPI usage error

Field Detail

<static> <constant> ERR_CLIENT

Exception type for a client-side error

<static> <constant> ERR_SERVER

Exception type for a server error

<static> <constant> ERR_USAGE

Exception type for an api usage error

Method Detail

{String} getDescription()

Returns a description:

SOAP string for ERR_SERVER
fileName+number+stack for ERR_CLIENT (Firefox only)
Anything set when creating this object for ERR_USER

Returns:: {String} Detailed description of error

{String} getErrCode()

Returns the error code for ERR_SERVER.

Returns:: {String} Error code for ERR_SERVER

{String} getMessage()

Returns a short message about the exception.

Returns:: {String} errMsg short message about the exception

{String} getType()

Returns the type of exception error.

Returns:: {String} errType Type of exception

{boolean} isExceptionType(exceptionType)

Returns whether this exception instance is of the given type.

Parameters:
{Object} exceptionType: exception type as string, or exception class. Examples: "actuate.viewer.ViewerException" or actuate.viewer.ViewerException

Returns:: {boolean} true if the exception is of the given type

Classes

Class actuate.Exception