i-net Clear Reports

com.inet.report.schedule
Class ScheduleException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by com.inet.report.schedule.ScheduleException
All Implemented Interfaces:
java.io.Serializable

public final class ScheduleException
extends java.lang.Exception

This Exception will be thrown if an error occurs during execution of a scheduled task.
There are defined two different types. If a ScheduleException is created without the idle time parameter and thrown, the scheduler should not retry to render the report.
The second possibility is to pass a number of seconds the scheduler should wait before he retries to render the report.

Since:
6.0
See Also:
Serialized Form

Constructor Summary
ScheduleException(java.lang.String message, java.lang.Throwable ex, java.lang.String errorNumber)
          Creates a ScheduleException with a certain error number.
ScheduleException(java.lang.String[] errors, java.lang.String errorNumber)
          Creates a ScheduleException with multiple error messages as cause.
ScheduleException(java.lang.String message, java.lang.String errorNumber)
          This constructor creates a ScheduleException without an idle time.
 
Method Summary
 java.lang.String getErrorCode()
          Returns the error code for this ScheduleException.
 java.lang.String[] getErrorMessages()
          Returns an array of error messages if multiple errors have been the cause for this ScheduleException.
 java.lang.String toString()
          Returns a string representation of this ScheduleException.
 

Constructor Detail

ScheduleException

public ScheduleException(java.lang.String message,
                         java.lang.Throwable ex,
                         java.lang.String errorNumber)
Creates a ScheduleException with a certain error number.

Parameters:
message - The message text of the ScheduleException.
ex - The cause of the exception.
errorNumber - The unique error number. (These error numbers are defined for internal use only)
Since:
6.1

ScheduleException

public ScheduleException(java.lang.String[] errors,
                         java.lang.String errorNumber)
Creates a ScheduleException with multiple error messages as cause.

Parameters:
errors - The error messages representing the cause of the exception.
errorNumber - The unique error number. (These error numbers are defined for internal use only)
Since:
6.1

ScheduleException

public ScheduleException(java.lang.String message,
                         java.lang.String errorNumber)
This constructor creates a ScheduleException without an idle time. This means that an error occurred and the scheduler should not retry to render the report

Parameters:
message - The message text of the error occurred.
errorNumber - The unique error number. (These error numbers are defined for internal use only)
Since:
6.1
Method Detail

toString

public java.lang.String toString()
Returns a string representation of this ScheduleException. It will contain the error number and the cause.

Overrides:
toString in class java.lang.Throwable
Returns:
A string representation of this ScheduleException.

getErrorMessages

public java.lang.String[] getErrorMessages()
Returns an array of error messages if multiple errors have been the cause for this ScheduleException.

Returns:
An array of error messages or null if a single error caused this ScheduleException.

getErrorCode

public java.lang.String getErrorCode()
Returns the error code for this ScheduleException. With this error code you can check what the reason for the ScheduleException was and perhaps retry an API call with another parameter combination.

Returns:
The error code for this ScheduleException.
Since:
6.5

i-net Clear Reports

Copyright © 1999-2015 by i-net software GmbH