Project: stp

javax.wvcm
Class WvcmException

Object
  extended by Throwable
      extended by Exception
          extended by javax.wvcm.WvcmException
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
StpException

public class WvcmException
extends Exception

An exception that indicates that a failure of some sort has occurred in the WVCM provider. A WvcmException contains information such as a code describing the reason for the failure and optionally an array of nested exceptions to further explain the cause of the error.

Since:
1.0
See Also:
Serialized Form

Nested Class Summary
static class WvcmException.ReasonCode
          The reason code for a WvcmException.
 
Constructor Summary
WvcmException(String message, Resource resource, WvcmException.ReasonCode reasonCode)
          Constructs a WvcmException.
WvcmException(String message, Resource resource, WvcmException.ReasonCode reasonCode, Throwable cause)
          Constructs a WvcmException.
WvcmException(String message, Resource resource, WvcmException.ReasonCode reasonCode, Throwable[] nestedExceptions)
          Constructs a WvcmException.
WvcmException(String message, Resource resource, WvcmException.ReasonCode reasonCode, Throwable cause, Throwable[] nestedExceptions)
          Constructs a WvcmException.
WvcmException(String message, WvcmException.ReasonCode reasonCode)
          Constructs a WvcmException.
 
Method Summary
 Throwable[] getNestedExceptions()
          Get any nested exceptions that further explain the cause of the error.
 WvcmException.ReasonCode getReasonCode()
          Get the reason code that describes the nature of the error.
 Resource getResource()
          Get the resource causing the exception.
 
Methods inherited from class Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
 
Methods inherited from class Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

WvcmException

public WvcmException(String message,
                     Resource resource,
                     WvcmException.ReasonCode reasonCode)
Constructs a WvcmException.

Parameters:
message - the detail message for the exception.
resource - the resource causing the exception.
reasonCode - the reason for the exception.

WvcmException

public WvcmException(String message,
                     Resource resource,
                     WvcmException.ReasonCode reasonCode,
                     Throwable cause)
Constructs a WvcmException.

Parameters:
message - the detail message for the exception.
resource - the resource causing the exception.
reasonCode - the reason for the exception.
cause - the exception that caused this exception.

WvcmException

public WvcmException(String message,
                     Resource resource,
                     WvcmException.ReasonCode reasonCode,
                     Throwable[] nestedExceptions)
Constructs a WvcmException.

Parameters:
message - the detail message for the exception.
resource - the resource causing the exception.
reasonCode - the reason for the exception.
nestedExceptions - any nested exception.

WvcmException

public WvcmException(String message,
                     Resource resource,
                     WvcmException.ReasonCode reasonCode,
                     Throwable cause,
                     Throwable[] nestedExceptions)
Constructs a WvcmException.

Parameters:
message - the detail message for the exception.
resource - the resource causing the exception.
reasonCode - the reason for the exception.
cause - the exception that caused this exception.
nestedExceptions - any nested exception.

WvcmException

public WvcmException(String message,
                     WvcmException.ReasonCode reasonCode)
Constructs a WvcmException.

Parameters:
message - the detail message for the exception.
reasonCode - the reason for the exception.
Method Detail

getNestedExceptions

public Throwable[] getNestedExceptions()
Get any nested exceptions that further explain the cause of the error.

Returns:
any nested exceptions that further explain the cause of the error.

getReasonCode

public WvcmException.ReasonCode getReasonCode()
Get the reason code that describes the nature of the error.

Returns:
the reason code that describes the nature of the error.

getResource

public Resource getResource()
Get the resource causing the exception.

Returns:
the resource causing the exception.

Generated Fri 15-Nov-2013 02:34 AM

Copyright © IBM 2013. All rights reserved.