com.appiancorp.suiteapi.process.framework

Class ActivityExecutionException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.appiancorp.suiteapi.process.framework.ActivityExecutionException

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

HandledActivityExecutionException, RetryableActivityExecutionException, UnattendedActivityValidationException

public class ActivityExecutionException
extends java.lang.Exception

This is an Exception wrapper, which is used by Activity classes to inform about error conditions while running the activity. This exception contains the actual exception that occurred while executing the activity. The exception can also contain messages for both user and the administrator. In the case of attended activity the message for the user will be displayed immediately. The actual error that occurred inside the activity class will be logged both on the Java and database side.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ActivityExecutionException(ErrorCode code, java.util.Locale locale, java.lang.Object... arguments)
ActivityExecutionException(java.lang.Exception cause, java.lang.String attendedMsg, java.lang.String notifyMsg) Construct a new ActivityExecutionException
ActivityExecutionException(java.lang.Exception cause, java.lang.String attendedMsg, java.lang.String notifyMsg, boolean notified) Construct a new ActivityExecutionException
ActivityExecutionException(java.lang.String attendedMsg, java.lang.String notifyMsg) Construct a new ActivityExecutionException
ActivityExecutionException(java.lang.String attendedMsg, java.lang.String notifyMsg, boolean notified) Construct a new ActivityExecutionException

Method Summary

Modifier and Type	Method and Description
java.lang.Exception	getException() Method returns the actual exception that occurred in the Activity class
java.lang.String	getExceptionClassName() Returns the name of the type of the exception that occurred in the activity class
boolean	getNotified() Has the process administrator been notified of this exception?
java.lang.String	getNotifyMessage() Gets the message that will be sent to the process initiator in a notification.
java.lang.String	getUserMessage() Returns the message set by the Activity class for the current user.
void	setNotified(boolean notified)
void	setNotifyMessage(java.lang.String notifyMessage) Sets the messages that will be sent to the process initiator in a notification.

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

ActivityExecutionException

public ActivityExecutionException(ErrorCode code,
                                  java.util.Locale locale,
                                  java.lang.Object... arguments)

ActivityExecutionException

public ActivityExecutionException(java.lang.Exception cause,
                                  java.lang.String attendedMsg,
                                  java.lang.String notifyMsg)

Construct a new ActivityExecutionException

Parameters:

cause - the exception which occurred while executing the activity

attendedMsg - the message to be displayed to the user in an attended activity

notifyMsg - the message to be sent to the process administrator

ActivityExecutionException

public ActivityExecutionException(java.lang.Exception cause,
                                  java.lang.String attendedMsg,
                                  java.lang.String notifyMsg,
                                  boolean notified)

Construct a new ActivityExecutionException

Parameters:

cause - the exception which occurred while executing the activity

attendedMsg - the message to be displayed to the user

adminMsg - the message to be sent to the process administrator

notified - whether or not the process administrator has been notified

ActivityExecutionException

public ActivityExecutionException(java.lang.String attendedMsg,
                                  java.lang.String notifyMsg)

Construct a new ActivityExecutionException

Parameters:

attendedMsg - the message to be displayed to the user in an attended activity

adminMsg - the message to be sent to the process administrator

ActivityExecutionException

public ActivityExecutionException(java.lang.String attendedMsg,
                                  java.lang.String notifyMsg,
                                  boolean notified)

Construct a new ActivityExecutionException

Parameters:

usrMsg - the message to be displayed to the user

adminMsg - the message to be sent to the process administrator

notified - whether or not the process administrator has been notified

Method Detail

getUserMessage

public java.lang.String getUserMessage()

Returns the message set by the Activity class for the current user. This will be displayed on the UI only in the case of attended activity classes.

Returns:

Error message for the user

getException

public java.lang.Exception getException()

Method returns the actual exception that occurred in the Activity class

Returns:

exception in the activity class

getNotifyMessage

public java.lang.String getNotifyMessage()

Gets the message that will be sent to the process initiator in a notification. By default, this value is the message of the exception.

Returns:

Message to be sent to the process initiator

setNotifyMessage

public void setNotifyMessage(java.lang.String notifyMessage)

Sets the messages that will be sent to the process initiator in a notification.

Parameters:

notifyMessage - the message to be sent to the process initiator

getExceptionClassName

public java.lang.String getExceptionClassName()

Returns the name of the type of the exception that occurred in the activity class

Returns:

Type name of the exception that occurred in the activity class

getNotified

public boolean getNotified()

Has the process administrator been notified of this exception?

Returns:

true if the process administrator has been notified; false otherwise

setNotified

public void setNotified(boolean notified)

See Also:

getNotified()