Package com.inet.viewer
Class ViewerException
java.lang.Object
java.lang.Throwable
java.lang.Exception
java.lang.RuntimeException
com.inet.viewer.ViewerException
- All Implemented Interfaces:
com.inet.error.HasErrorCode
,Serializable
@JsonData
public class ViewerException
extends RuntimeException
implements Serializable, com.inet.error.HasErrorCode
An exception wrapper class for the i-net Clear Reports Viewer.
Contains all information necessary for dealing with various exceptions.
Contains all information necessary for dealing with various exceptions.
One of the most important uses of ViewerException is for prompt event handling: A ViewerException can be thrown if prompts are needed, in which case the flag "needPrompts" is true.
- Since:
- 7.0
- See Also:
-
Constructor Summary
ConstructorDescriptionViewerException
(int errorCode, String message, String format, String srvVersion, String srvJVM, String srvOS, int srvCache, String stacktrace) Initializes an exception from the server with the given error code, message, export format, server version, server JAva VM, server OS, server cache version, and stacktrace.ViewerException
(int errorCode, String message, String format, String srvVersion, String srvJVM, String srvOS, int srvCache, String protocol, Throwable cause) Initializes an exception from the server with the given error code, message, export format, server version, server Java VM, server OS, server cache version, protocol, and stacktrace.ViewerException
(int errorCode, String message, String format, String srvVersion, String srvJVM, String srvOS, int srvCache, String protocol, Throwable cause, String supportEmail) Initializes an exception from the server with the given error code, message, export format, server version, server Java VM, server OS, server cache version, protocol, and stacktrace.ViewerException
(int errorCode, String message, String format, String srvVersion, String srvJVM, String srvOS, int srvCache, Throwable cause) Initializes an exception from the server with the given error code, message, export format, server version, server Java VM, server OS, server cache version, and stacktrace.ViewerException
(PromptData[] prompts) For the "need prompts" Viewer ExceptionViewerException
(String message) Initializes an exception with the given error messageViewerException
(String message, Throwable cause) Initializes an exception with the given error message and wraps another Throwable in this ViewerException -
Method Summary
Modifier and TypeMethodDescriptionstatic ViewerException
createViewerException
(Throwable cause) Simple factory method for creating a ViewerException as a Wrapper for a Throwable.static ViewerException
createViewerExceptionWithMessage
(String message, Throwable cause) Wraps the given exception in a ViewerException.int
Returns the error code of the exception that was thrown on report server.static String
Create a user friendly error message.Sets the array of prompt information - prompt information is stored as Prompt data objects If this is not an exception encapsulating a prompt request, this will return nullboolean
Whether this exception encapsulates a prompt request - in other words meaning the report can not be rendered until the prompts specified by getPrompts() are provided to the servervoid
setNeedPrompts
(boolean needPrompts) Sets whether this exception encapsulates a prompt request - in other words meaning the report can not be rendered until the prompts specified by getPrompts() are provided to the servervoid
setPrompts
(PromptData[] prompts) Sets the array of prompt information - prompt information is stored as Prompt data objectsMethods inherited from class java.lang.Throwable
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
-
Constructor Details
-
ViewerException
public ViewerException(int errorCode, String message, String format, String srvVersion, String srvJVM, String srvOS, int srvCache, String stacktrace) Initializes an exception from the server with the given error code, message, export format, server version, server JAva VM, server OS, server cache version, and stacktrace.- Parameters:
errorCode
- Error code of exception thrown on server sidemessage
- Error message of exceptionformat
- Export format at the time of the exceptionsrvVersion
- Server's i-net Clear Reports versionsrvJVM
- Server's Java VM versionsrvOS
- Server's Operating SystemsrvCache
- Server's Cache Version of i-net Clear Reportsstacktrace
- Stacktrace of exception thrown on server side.- Since:
- 7.0
-
ViewerException
public ViewerException(int errorCode, String message, String format, String srvVersion, String srvJVM, String srvOS, int srvCache, Throwable cause) Initializes an exception from the server with the given error code, message, export format, server version, server Java VM, server OS, server cache version, and stacktrace.- Parameters:
errorCode
- Error code of exception thrown on server sidemessage
- Error message of exceptionformat
- Export format at the time of the exceptionsrvVersion
- Server's i-net Clear Reports versionsrvJVM
- Server's Java VM versionsrvOS
- Server's Operating SystemsrvCache
- Server's Cache Version of i-net Clear Reportscause
- Initializes the cause of this ViewerException to the specified value.- Since:
- 8.1
-
ViewerException
public ViewerException(int errorCode, String message, String format, String srvVersion, String srvJVM, String srvOS, int srvCache, String protocol, Throwable cause) Initializes an exception from the server with the given error code, message, export format, server version, server Java VM, server OS, server cache version, protocol, and stacktrace.- Parameters:
errorCode
- Error code of exception thrown on server sidemessage
- Error message of exceptionformat
- Export format at the time of the exceptionsrvVersion
- Server's i-net Clear Reports versionsrvJVM
- Server's Java VM versionsrvOS
- Server's Operating SystemsrvCache
- Server's Cache Version of i-net Clear Reportsprotocol
- Protocol version usedcause
- Initializes the cause of this ViewerException to the specified value.- Since:
- 7.0
-
ViewerException
public ViewerException(int errorCode, String message, String format, String srvVersion, String srvJVM, String srvOS, int srvCache, String protocol, Throwable cause, String supportEmail) Initializes an exception from the server with the given error code, message, export format, server version, server Java VM, server OS, server cache version, protocol, and stacktrace.- Parameters:
errorCode
- Error code of exception thrown on server sidemessage
- Error message of exceptionformat
- Export format at the time of the exceptionsrvVersion
- Server's i-net Clear Reports versionsrvJVM
- Server's Java VM versionsrvOS
- Server's Operating SystemsrvCache
- Server's Cache Version of i-net Clear Reportsprotocol
- Protocol version usedcause
- Initializes the cause of this ViewerException to the specified value.supportEmail
- optional support email- Since:
- 14.0
-
ViewerException
Initializes an exception with the given error message- Parameters:
message
- Error message- Since:
- 7.0
-
ViewerException
Initializes an exception with the given error message and wraps another Throwable in this ViewerException- Parameters:
message
- Error message of this exceptioncause
- Throwable to wrap in this ViewerException- Since:
- 7.0
-
ViewerException
For the "need prompts" Viewer Exception- Parameters:
prompts
- Prompts needed: Array of prompt information - each prompt data object holds information about what type of prompt, what default values there are, etc.- Since:
- 7.0
- See Also:
-
-
Method Details
-
createViewerException
Simple factory method for creating a ViewerException as a Wrapper for a Throwable.- Parameters:
cause
- Throwable to wrap in this ViewerException- Returns:
- New ViewerException wrapping Throwable
- Since:
- 7.0
-
createViewerExceptionWithMessage
Wraps the given exception in a ViewerException. If the given exception is a ViewerException, the message is appended to the beginning and all parameters such as error code, etc., are preserved.- Parameters:
message
- String to append to the beginningcause
- Throwable to wrap- Returns:
- New ViewerException wrapping Throwable with appended message.
- Since:
- 7.0
-
getErrorCode
public int getErrorCode()Returns the error code of the exception that was thrown on report server.- Specified by:
getErrorCode
in interfacecom.inet.error.HasErrorCode
- Returns:
- errorCode Error code of exception thrown on server side
- Since:
- 10.0
-
getErrorMessage
Create a user friendly error message. Returns the error message contained in the given throwable, add the class name without package if it to short.- Parameters:
th
- Throwable to extract error message from, truncated if necessary- Returns:
- Message contained in the Throwable.
- Since:
- 11.1
-
setPrompts
Sets the array of prompt information - prompt information is stored as Prompt data objects- Parameters:
prompts
- Array of prompts to store in this exception- Since:
- 7.0
-
getPrompts
Sets the array of prompt information - prompt information is stored as Prompt data objects If this is not an exception encapsulating a prompt request, this will return null- Returns:
- Prompt data objects
- Since:
- 7.0
-
setNeedPrompts
public void setNeedPrompts(boolean needPrompts) Sets whether this exception encapsulates a prompt request - in other words meaning the report can not be rendered until the prompts specified by getPrompts() are provided to the server- Parameters:
needPrompts
- Does this exception encapsulate a prompt request?- Since:
- 7.0
-
isNeedPrompts
public boolean isNeedPrompts()Whether this exception encapsulates a prompt request - in other words meaning the report can not be rendered until the prompts specified by getPrompts() are provided to the server- Returns:
- needPrompts Does this exception encapsulate a prompt request?
- Since:
- 7.0
-