Visit Platform at http://www.platform.com

Platform Symphony 5.0 Java API Reference

com.platform.symphony.soam
Class SoamException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by com.platform.symphony.soam.SoamException
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
FailureException, FatalException

public class SoamException
extends java.lang.Exception

See Also:
Serialized Form

Constructor Summary
SoamException()
          Constructs an exception with a null detail message and no cause.
SoamException(java.lang.String message)
          Constructs an exception with the provided detail message and no cause.
SoamException(java.lang.String message, int errorCode)
          Constructs an exception with the provided detail message and associated error code.
SoamException(java.lang.String message, java.lang.Throwable cause)
          Constructs an exception with the provided detail message and cause.
SoamException(java.lang.Throwable cause)
          Constructs an exception with a null detail message and the provided cause.
 
Method Summary
 java.lang.Exception getEmbeddedException()
          Returns the embedded exception object.
 int getErrorCode()
          Returns the error code associated with the exception.
 java.lang.String getErrorType()
          Returns the type of the exception by name for example "FailureException".
 java.lang.String toString()
          Returns a description of this exception.
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

SoamException

public SoamException()
Constructs an exception with a null detail message and no cause. The cause may be later initialized by invoking initCause.


SoamException

public SoamException(java.lang.String message)
Constructs an exception with the provided detail message and no cause. The cause may be later initialized by invoking initCause.

Parameters:
message - The detail message. The detail message can be accessed by invoking getMessage.

SoamException

public SoamException(java.lang.String message,
                     int errorCode)
Constructs an exception with the provided detail message and associated error code.

Parameters:
message - The detail message. The detail message can be accessed by invoking getMessage.
errorCode - The Error Code message. The detail message can be accessed by invoking getErrorCode.

SoamException

public SoamException(java.lang.String message,
                     java.lang.Throwable cause)
Constructs an exception with the provided detail message and cause.

Parameters:
message - The detail message. The detail message can be accessed by invoking getMessage.
cause - The cause of the exception. The cause can be accessed by invoking getCause.

SoamException

public SoamException(java.lang.Throwable cause)
Constructs an exception with a null detail message and the provided cause.

Parameters:
cause - The cause of the exception. The cause can be accessed by invoking getCause.
Method Detail

toString

public java.lang.String toString()
Returns a description of this exception.

Overrides:
toString in class java.lang.Throwable
Returns:
The description of this exception

getErrorCode

public int getErrorCode()
Returns the error code associated with the exception.

Returns:
The error code associated with this exception

getErrorType

public java.lang.String getErrorType()
Returns the type of the exception by name for example "FailureException".

Returns:
The type of the exception

getEmbeddedException

public java.lang.Exception getEmbeddedException()
                                         throws SoamException
Returns the embedded exception object.

When an exception is thrown from the service, the middleware will embed the service exception within a SoamException to provide context.

This method will retrieve the embedded exception thrown in the service. If no exception is embedded it will return null.

Returns:
The embedded exception
Throws:
SoamException

Version 5.0
Date Modified: -DREL_DATE=Nov 11 2009
Platform Computing. Accelerating Intelligence(TM).
Copyright (C) 2001-2009 Platform Computing Corporation. All rights reserved.