Package com.microstrategy.web.tasks

Class TaskException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.microstrategy.web.tasks.TaskException

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

TaskConfigurationException, TaskInternalException, TaskNotFoundException, TaskNotRequestedException, TaskRequestCSRFValidationException, TaskRequestMalformedException, TaskUnauthorizedException

public class TaskException
extends java.lang.Exception

This is the base class for a set of task-related exceptions.

Since:

MicroStrategy Web 8.1.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
TaskException(java.lang.String msg)	Creates a new TaskException object.
TaskException(java.lang.String msg, AuditEvent event)	Creates a new TaskException object with Audit information populated.
TaskException(java.lang.String message, java.lang.Throwable e)	Creates a new TaskException object.
TaskException(java.lang.Throwable e)	Creates a new TaskException object.

Method Summary

Modifier and Type	Method	Description
AuditEvent	getAuditInfo()	Gets the audit event associated with the exception
java.lang.String	getGenericMessage()	Returns the generic message for this exception.
int	getStatusCode()	Returns the Status code associated with this exception.
java.lang.Integer	getTaskErrorCode()	Returns the Task Error Code associated with this exception.
void	setAuditInfo(AuditEvent auditInfo)	Sets the audit event information associated with the exception
void	setGenericMessage(java.lang.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.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, 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

Constructor Detail

TaskException

public TaskException(java.lang.String msg)

Creates a new TaskException object.

Parameters:

msg - Error message

TaskException

public TaskException(java.lang.Throwable e)

Creates a new TaskException object.

Parameters:

e - Exception

TaskException

public TaskException(java.lang.String message,
                     java.lang.Throwable e)

Creates a new TaskException object.

Parameters:

message - Error message

e - Exception

Since:

MicroStrategy Web 9.0.0

TaskException

public TaskException(java.lang.String msg,
                     AuditEvent event)

Creates a new TaskException object with Audit information populated.

Parameters:

msg - Error message

event - AuditEvent associated with exception

Method Detail

getStatusCode

public int getStatusCode()

Returns the Status code associated with this exception.

Returns:

The Status code associated with this exception.

setStatusCode

public void setStatusCode(int statusCode)

Sets the Status code associated with this exception.

Parameters:

statusCode - The Status code associated with this exception.

getTaskErrorCode

public java.lang.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.

setTaskErrorCode

public void setTaskErrorCode(int taskErrCode)

Sets the Task Error Code for this exception.

Parameters:

taskErrCode - An integer, task-specific error code.

getGenericMessage

public java.lang.String getGenericMessage()

Returns the generic message for this exception.

Returns:

The generic message.

setGenericMessage

public void setGenericMessage(java.lang.String genericMessage)

Sets the generic message for this exception.

Parameters:

genericMessage - generic message

getAuditInfo

public AuditEvent getAuditInfo()

Gets the audit event associated with the exception

Returns:

AuditEvent

setAuditInfo

public void setAuditInfo(AuditEvent auditInfo)

Sets the audit event information associated with the exception

Parameters:

auditInfo - - AuditEvent object