EdmiException

edm.edom3.exception

Class EdmiException

• java.lang.Object
• • java.lang.Throwable
  • • java.lang.Exception
    • • edm.edom3.exception.EdmiException

• All Implemented Interfaces:java.io.Serializable

  Direct Known Subclasses:EdmiNativeException, EDMNotImplementedException, EdmUserException

  ---

  
  

  public class EdmiException
  extends java.lang.Exception

  
  This exception class is base for errors in the JAVA siode of the EDMI interface. 
  Copyright(C) EPM Technology AS.

  Version:3Author:Arne Toen, EPM Technology AS.See Also:Serialized Form

• • Field Summary

    Fields 

    Modifier and Type	Field and Description
    protected int	m_edmiError
    protected java.lang.String	m_edmiErrorMessage
    protected java.lang.String	m_location
    protected java.lang.String	m_message

  • Constructor Summary

    Constructors 

    Constructor and Description
    EdmiException(EdmiException ex) Create a new exception with the given object
    EdmiException(java.lang.Object obj, java.lang.String message) Create new EdmiException
    EdmiException(java.lang.Object obj, java.lang.String method, java.lang.Exception rootCause) Create a new EdmiException
    EdmiException(java.lang.Object obj, java.lang.String method, java.lang.String message) Create new EdmiException
    EdmiException(java.lang.String message) Create new EdmiException construction

  • Method Summary

    All Methods Static Methods Instance Methods Concrete Methods 

    Modifier and Type	Method and Description
    int	getErrorCode() Get error code for this exception
    static java.lang.String	getErrorText(int errCode) Get error text out of an error code
    java.lang.String	getMessage() Get complete error message
    void	setContextId(long id) Set context id
    void	setErrorCode(long errorCode) Set error code
    void	setErrorCodeMessage(java.lang.String message) Set error code message (alternative to above)
    void	setLocation(java.lang.String s) Set error location
    void	setMessage(java.lang.String s) Set error location

    • Methods inherited from class java.lang.Throwable

      addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

    • Methods inherited from class java.lang.Object

      clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

• • Field Detail

    • m_edmiError

      protected int m_edmiError

    • m_location

      protected java.lang.String m_location

    • m_message

      protected java.lang.String m_message

    • m_edmiErrorMessage

      protected java.lang.String m_edmiErrorMessage

  • Constructor Detail

    • EdmiException

      public EdmiException(java.lang.String message)

      
      Create new EdmiException construction

      Parameters:message - create a new exception with the following message

    • EdmiException

      public EdmiException(EdmiException ex)

      
      Create a new exception with the given object

      Parameters:ex - exception object

    • EdmiException

      public EdmiException(java.lang.Object obj,
                           java.lang.String method,
                           java.lang.String message)

      
      Create new EdmiException

      Parameters:obj - object where the exception took placemethod - method where the exception tool placemessage - exception message

    • EdmiException

      public EdmiException(java.lang.Object obj,
                           java.lang.String method,
                           java.lang.Exception rootCause)

      
      Create a new EdmiException

      Parameters:obj - object where the exception took placemethod - method where the exception tool placerootCause - exception message

    • EdmiException

      public EdmiException(java.lang.Object obj,
                           java.lang.String message)

      
      Create new EdmiException

      Parameters:obj - object where the exception took placemessage - exception message

  • Method Detail

    • setErrorCode

      public void setErrorCode(long errorCode)

      
      Set error code

      Parameters:errorCode - error code for the exception

    • setErrorCodeMessage

      public void setErrorCodeMessage(java.lang.String message)

      
      Set error code message (alternative to above)

      Parameters:message - code for the exception

    • setContextId

      public void setContextId(long id)

      
      Set context id

      Parameters:id - context id

    • setLocation

      public void setLocation(java.lang.String s)

      
      Set error location

      Parameters:s - location of the exception

    • setMessage

      public void setMessage(java.lang.String s)

      
      Set error location

      Parameters:s - exception message

    • getMessage

      public java.lang.String getMessage()

      
      Get complete error message

      Overrides:getMessage in class java.lang.ThrowableReturns:exception message

    • getErrorCode

      public int getErrorCode()

      
      Get error code for this exception

      Returns:exception error code

    • getErrorText

      public static java.lang.String getErrorText(int errCode)

      
      Get error text out of an error code

      Parameters:errCode - error code numberReturns:error code message