Class actuate.viewer.ViewerException

Represents a viewer exception.
Member of: actuate.viewer.

Class Summary
Constructor Attributes	Constructor Name and Description
	actuate.viewer.ViewerException() Constructs a viewer exception.

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
	getElement() Returns an instance of the currently selected element.
	getErrCode() Returns the error code for ERR_SERVER.
	getErrorMessage() Returns the exception message.
	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.viewer.ViewerException()

Constructs a viewer exception.

See:: actuate.viewer.EventConstants

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

{Object} getElement()

Returns an instance of the currently selected element. The instance can be one of the following objects:

To determine the object type, use the Object.getType( ) function. The type strings for the above objects are "Chart", "Data", "Label", "Table", or "Text", respectively. This example displays the type of element that generated the exception in an alert box:

	alert("Exception in " + vException.getElement.getType( ));

Returns:: {Object} report element for which the exception occurred.

{String} getErrCode()

Returns the error code for ERR_SERVER.

Returns:: {String} Error code for ERR_SERVER

{String} getErrorMessage()

Returns the exception message. This example displays the server error code in an alert box:

	alert("Server error message: " + vException.getErrorMessage( ));

Returns:: {String} exception message

{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.viewer.ViewerException