public
class
HandlerException
extends Exception| java.lang.Object | |||
| ↳ | java.lang.Throwable | ||
| ↳ | java.lang.Exception | ||
| ↳ | com.microstrategy.web.objects.actions.HandlerException | ||
 Known Direct Subclasses
|
Class Overview
This is the base class for a set of task-related exceptions.
Summary
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
HandlerException(String msg)
Creates a new HandlerException object.
| |||||||||||
|
HandlerException(Throwable e)
Creates a new HandlerException object.
| |||||||||||
|
HandlerException(String message, Throwable e)
Creates a new HandlerException object.
| |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| String |
getGenericMessage()
Returns the generic message for this exception.
| ||||||||||
| int |
getStatusCode()
Returns the Status code associated with this exception.
| ||||||||||
| Integer |
getTaskErrorCode()
Returns the Task Error Code associated with this exception.
| ||||||||||
| void |
setGenericMessage(String genericMessage)
Sets the generic message for this exception.
| ||||||||||
| void |
setStatusCode(int statusCode)
Sets the Status code associated with this exception.
| ||||||||||
| void |
setTaskErrorCode(int taskErrCode)
Sets the Task Error Code for this exception.
| ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From class
java.lang.Throwable
| |||||||||||
|
From class
java.lang.Object
| |||||||||||
Public Constructors
public HandlerException (String msg)
Creates a new HandlerException object.
Parameters
| msg | Error message |
|---|
public HandlerException (Throwable e)
Creates a new HandlerException object.
Parameters
| e | Exception |
|---|
public HandlerException (String message, Throwable e)
Creates a new HandlerException object.
Parameters
| message | Error message |
|---|---|
| e | Exception |
Public Methods
public String getGenericMessage ()
Returns the generic message for this exception.
Returns
- The generic message.
public int getStatusCode ()
Returns the Status code associated with this exception.
Returns
- The Status code associated with this exception.
public Integer getTaskErrorCode ()
Returns the Task Error Code associated with this exception.
Returns
- The Task Error Code (as an Integer). If null, no error code has been specified.
public void setGenericMessage (String genericMessage)
Sets the generic message for this exception.
Parameters
| genericMessage | generic message |
|---|
public void setStatusCode (int statusCode)
Sets the Status code associated with this exception.
Parameters
| statusCode | The Status code associated with this exception. |
|---|
public void setTaskErrorCode (int taskErrCode)
Sets the Task Error Code for this exception.
Parameters
| taskErrCode | An integer, task-specific error code. |
|---|