Class actuate.xtabanalyzer.Exception

The Exception class represents an exception for xtab analyzer.
Member of: actuate.xtabanalyzer.

Class Summary
Constructor Attributes	Constructor Name and Description
	actuate.xtabanalyzer.Exception() The Exception class represents an exception for xtab analyzer.

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

Method Summary
Method Attributes	Method Name and Description
	getDescription() Return description - soap string for ERR_SERVER, - fileName+number+stack for ERR_CLIENT(firefox only), - And as for ERR_USER anything set when creating this object
	getElement() Returns the report element for which the exception occurred, if available.
	getErrCode() Return error code for ERR_SERVER
	getMessage() Return short message about exception
	getType() Return the type of exception error
	isExceptionType(exceptionType) Returns whether this exception instance is of the given type.

Class Detail

actuate.xtabanalyzer.Exception()

The Exception class represents an exception for xtab analyzer.

Field Detail

<static> <constant> ERR_CLIENT

Exception type for client side error

<static> <constant> ERR_SERVER

Exception type for server error.

<static> <constant> ERR_USAGE

Exception type for api usage error

Method Detail

{String} getDescription()

Return description - soap string for ERR_SERVER, - fileName+number+stack for ERR_CLIENT(firefox only), - And as for ERR_USER anything set when creating this object

Returns:: {String} detail description of error

getElement()

Returns the report element for which the exception occurred, if available.

Returns:: report element for which the exception occurred

{String} getErrCode()

Return error code for ERR_SERVER

Returns:: {String} error code for ERR_SERVER

{String} getMessage()

Return short message about exception

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

{String} getType()

Return 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.xtabanalyzer.Exception