com.ibm.itim.workflow.model

Class WorkflowException

  • All Implemented Interfaces:
    java.io.Serializable
    Direct Known Subclasses:
    InvalidQueryException


    public class WorkflowException
    extends ITIMException
    This class is used for errors that occured within the workflow engine.
    See Also:
    Serialized Form
    • Constructor Summary

      Constructors 
      Constructor and Description
      WorkflowException(java.lang.String errCode)
      Deprecated. 
      Use new construtor WorkflowException(String msg, Object[] tokenValues, Throwable cause)
      WorkflowException(java.lang.String messageId, java.lang.Object[] tokens, java.lang.Throwable cause)
      Constructs a new exception with an error message id, tokens, and the cause of the exception.
      WorkflowException(java.lang.String errCode, java.lang.String exMsg)
      Deprecated. 
      Use new construtor WorkflowException(String msg, Object[] tokenValues, Throwable cause)
      WorkflowException(java.lang.String errCode, java.lang.Throwable cause)
      Deprecated. 
      Use new construtor WorkflowException(String msg, Object[] tokenValues, Throwable cause)
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      java.lang.String getErrorCode()
      Returns the error code.
      java.lang.String getExtraMessage()
      Returns the additional information (if any) in string format.
      java.lang.String getMessage(java.util.Locale locale)
      Returns localized error message according to the specified locale.
      void printStackTrace()
      Prints out the stack trace, including the stack trace of the original exception (if there was a separate one).
      void printStackTrace(java.io.PrintStream ps)
      Prints out the stack trace, including the stack trace of the original exception (if there was a separate one).
      void printStackTrace(java.io.PrintWriter pw)
      Prints out the stack trace, including the stack trace of the original exception (if there was a separate one).
      • Methods inherited from class java.lang.Throwable

        addSuppressed, fillInStackTrace, getCause, getStackTrace, getSuppressed, initCause, setStackTrace, toString
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • WorkflowException

        public WorkflowException(java.lang.String errCode)
        Deprecated. Use new construtor WorkflowException(String msg, Object[] tokenValues, Throwable cause)
        Constructs with an error code.
      • WorkflowException

        public WorkflowException(java.lang.String errCode,
                                 java.lang.String exMsg)
        Deprecated. Use new construtor WorkflowException(String msg, Object[] tokenValues, Throwable cause)
        Constructs with an error code and an extra message string.
        Parameters:
        errCode - Error code identifying the problem.
        exMsg - Additional information in a String.
      • WorkflowException

        public WorkflowException(java.lang.String errCode,
                                 java.lang.Throwable cause)
        Deprecated. Use new construtor WorkflowException(String msg, Object[] tokenValues, Throwable cause)
        Constructs with an error code and the cause exception.
        Parameters:
        errCode - Error code identifying the problem.
        cause - Throwable representing the exception causing this exception.
      • WorkflowException

        public WorkflowException(java.lang.String messageId,
                                 java.lang.Object[] tokens,
                                 java.lang.Throwable cause)
        Constructs a new exception with an error message id, tokens, and the cause of the exception.
        Parameters:
        messageId - Message id of the message identifying the problem.
        tokens - Tokens of data to use in the corresponding message representing the message id.
        cause - Throwable representing the exception causing this exception.
        Since:
        ITIM 4.6
    • Method Detail

      • getMessage

        public java.lang.String getMessage(java.util.Locale locale)
        Returns localized error message according to the specified locale.
        Overrides:
        getMessage in class ITIMException
        Parameters:
        locale - Locale to use for localization.
        Returns:
        a localized message, or, in the absence of a ResourceBundle from which to translate, returns a message key.
      • getErrorCode

        public java.lang.String getErrorCode()
        Returns the error code.
      • getExtraMessage

        public java.lang.String getExtraMessage()
        Returns the additional information (if any) in string format.
      • printStackTrace

        public void printStackTrace()
        Prints out the stack trace, including the stack trace of the original exception (if there was a separate one).
        Overrides:
        printStackTrace in class ITIMException
      • printStackTrace

        public void printStackTrace(java.io.PrintStream ps)
        Prints out the stack trace, including the stack trace of the original exception (if there was a separate one).
        Overrides:
        printStackTrace in class ITIMException
      • printStackTrace

        public void printStackTrace(java.io.PrintWriter pw)
        Prints out the stack trace, including the stack trace of the original exception (if there was a separate one).
        Overrides:
        printStackTrace in class ITIMException